codehz/BedrockMod

Proposal: Documentation Enhancement & Code Organization

johnbanq opened this issue · 7 comments

This is a project that is too good to exist without any docs on how to use it
Therefore,I propose a way to write docs & organize code for the various mod the project provides:

Code Organization
the code for each individual mod are placed in src/
eg: prop.cpp for chai_prop.so should be moved to src/prop/prop.cpp

Documentation & Examples
the docs and examples for a mod are placed in docs/
eg: docs and examples for chai_prop.so should be placed in docs/prop

Pros
the codebase will be more organized ,so it wont go too messy when we add more mods

Cons
the complexity of makefile will grow,since we must deal with sources behind the directories

Examples
I made a small example on the prop mod in my fork,feel free to check it out

btw,I would still work on the docs in docs/ or on the wiki if the ways of organizing code wasn't accepted
this project should get some docs anyway

Well, I'm going to find something alternative to Makefile, so I can reorganization without modify the fxxk Makefile... do you have some idea? (PS: I don't like to use cmake)
alternative to gnu make:

  1. xmake
  2. more...

Sorry for cant helping with that :( I am rather spoiled by IDE so I dunno which to choose neither

e5a58ee
the build system has been restructuring
and the docs is coming soon

awesome,will wait for a example before helping with the docs

@johnbanq Wiki pages has been created!

THANKS!