diff options
Diffstat (limited to 'docs/using-celeritas.md')
| -rw-r--r-- | docs/using-celeritas.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/using-celeritas.md b/docs/using-celeritas.md new file mode 100644 index 0000000..ceb3b7c --- /dev/null +++ b/docs/using-celeritas.md @@ -0,0 +1,10 @@ +--- +title: Using Celeritas +--- + +**TL;DR** + +- use the amalgamation header `celeritas.h` that exposes all public functions in a single header + - _you can recreate it with_ `scripts/amalgamation/gen_header.py` +- link the precompiled `core_static` or `core_shared` libraries +- _or_ compile using `xmake build`, the binaries will be in `build/<os>/x64/core_static`, etc
\ No newline at end of file |