GM4_Datapacks icon indicating copy to clipboard operation
GM4_Datapacks copied to clipboard

Add README in each module

Open BPR02 opened this issue 3 years ago • 3 comments

Adds READMEs, Licenses, and examples in each library module

TODO:

  • [ ] teleport example for lib_forceload
  • [x] lib_machines examples
  • [ ] put READMEs and examples in base modules (fruiting trees, relocators, orbis, etc.)

BPR02 avatar May 30 '22 19:05 BPR02

Examples shouldn't be in the data folder, as that would mean they get included in the modules. Imo a better place would be lib_forceload/examples/example_name/. This also means you don't need ugly hacks like _example_values.

misode avatar May 30 '22 19:05 misode

Okay, I was debating how to put the examples cuz in the separate repos we just had them as separate packs. So in examples would it be a full data pack with pack.mcmeta and the data folder?

BPR02 avatar May 30 '22 19:05 BPR02

So in examples would it be a full data pack with pack.mcmeta and the data folder?

Yes that would be good. Unless we want to use Lectern for our examples, but I guess that would be weird with the rest of our modules not really using beet.

misode avatar May 30 '22 19:05 misode

We're closing this PR as it is very outdated and it seems better to start with a fresh PR based on the current master branch and set a smaller scope for the PR.

Bloo-dev avatar Jan 02 '23 20:01 Bloo-dev