diff options
author | omnisci3nce <omniscient.oce@gmail.com> | 2024-07-14 21:47:25 +1000 |
---|---|---|
committer | omnisci3nce <omniscient.oce@gmail.com> | 2024-07-14 21:47:25 +1000 |
commit | 529a603128d5e9dc4701322f44961f165e2183e1 (patch) | |
tree | 3e5d65ac503b971412ae35bfc5fb67a438a3c364 /README.md | |
parent | 5b001d39d42314085164724d3a417fb8ebd54f98 (diff) |
generate api docs python
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -1,7 +1,8 @@ # 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. +Celeritas is an engine 'core' written in C that acts as an extendable base layer for creating custom game-specific "engines" (frameworks). It includes helpful wrappers around input handling, cameras, rendering abstractions, and other helpful APIs for making games and binding to other languages' FFIs. + +Higher-level concepts can then be overlaid on top of this core! ![Backpack model with lighting](examples/obj_loading/backpack_screenshot.png) @@ -9,6 +10,15 @@ for making games and binding to other languages' FFIs. All third-party dependencies are licensed under their own license. +## Project Structure + +``` +/bindgen - bindings code generation for other languages +/deps - third-party dependencies +/docs - high-level documentation +/scripts +``` + ## Developing #### Handy commands |