From 529a603128d5e9dc4701322f44961f165e2183e1 Mon Sep 17 00:00:00 2001 From: omnisci3nce Date: Sun, 14 Jul 2024 21:47:25 +1000 Subject: generate api docs python --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b5305ef..5ec3d37 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3-70-g09d2