From db6471e59e87d90bec6f1d6c31866f46253edf7a Mon Sep 17 00:00:00 2001 From: bjorn Date: Mon, 20 May 2019 11:14:56 -0700 Subject: [PATCH] Update CONTRIBUTING with folder structure changes; --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6b622da..c1e68797 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,11 +47,12 @@ An overview of the folder structure: - `deps` contains submodules for external dependencies. Some smaller dependencies are also included in the `src/lib` folder. -- `src/api` contains Lua bindings. There's a file for each module in there, and a `types` folder -with a file for each type of object. -- `src/resources` contains embedded resources. These are compiled to binary headers using `xxd`. -- `src/data` has stuff for loading various file formats into LÖVR data structures. -- Each module has a folder in `src`. +- `src/api` contains Lua bindings. There's a file for each module and a file for each object. +- `src/core` contains shared engine code. It's usually lower-level and not specific to LÖVR. +- `src/lib` contains smaller third party libraries. +- `src/modules` has a folder for each module in the project. It's good to keep them separated as + 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 frequently but breaking changes will still occur before version 1.0.