lpnf
/
lovr
mirror of https://github.com/bjornbytes/lovr.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING with folder structure changes;

This commit is contained in:
bjorn 2019-05-20 11:14:56 -07:00
parent 67b76e08c2
commit db6471e59e
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -47,11 +47,12 @@ An overview of the folder structure:
- `deps` contains submodules for external dependencies. Some smaller dependencies are also included - `deps` contains submodules for external dependencies. Some smaller dependencies are also included
in the `src/lib` folder. in the `src/lib` folder.
- `src/api` contains Lua bindings. There's a file for each module in there, and a `types` folder - `src/api` contains Lua bindings. There's a file for each module and a file for each object.
with a file for each type of object. - `src/core` contains shared engine code. It's usually lower-level and not specific to LÖVR.
- `src/resources` contains embedded resources. These are compiled to binary headers using `xxd`. - `src/lib` contains smaller third party libraries.
- `src/data` has stuff for loading various file formats into LÖVR data structures. - `src/modules` has a folder for each module in the project. It's good to keep them separated as
- Each module has a folder in `src`. much as possible, there's inevitably some overlap.
- `src/resources` contains embedded files. These are compiled to binary headers using `xxd`.
Note that currently the internal C API may change at any time. The Lua API will change less Note that currently the internal C API may change at any time. The Lua API will change less
frequently but breaking changes will still occur before version 1.0. frequently but breaking changes will still occur before version 1.0.