diff options
| -rw-r--r-- | README.md | 19 |
1 files changed, 6 insertions, 13 deletions
@@ -1,28 +1,22 @@ # celeritas-core - +Celeritas is an engine written in C that acts as an extendable base layer for creating custom game-specific "engines" (frameworks) that includes helpful wrappers around input handling, cameras, rendering abstractions, and other helpful APIs +for making games and binding to other languages' FFIs. + -**Work-in-progress**: This code is currently in flux as I port from OpenGL to a Vulkan backend with a homemade graphics API abstraction layer I'm developing named **RAL** (render abstraction layer) in the source code. +**Work-in-progress**: This code is currently in flux as I experiment with APIs and is ultimately intended to support a 3D game I'm in the process of making. All third-party dependencies are licensed under their own license. -## "Modules" - -| prefix | module | Description | -| --------- | ----------- | ----------- | -| `gpu` | RAL | | -| `plat` | Platforn | | -| `phys` | Physics | | +## Developing -## Notes +#### Handy commands * Check symbols in an 'archive' (static library) * `nm -C build/libcore.a` - * Generate compiler_commands.json * `xmake project -k compile_commands` - * Formatting * `xmake format` * Lint (no change) `find src/ -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror` @@ -31,6 +25,5 @@ All third-party dependencies are licensed under their own license. * Documentation * serve mkdocs locally * `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` - * Build docs static site * `docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build` |