diff options
| author | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 12:08:41 +1000 |
|---|---|---|
| committer | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 12:08:41 +1000 |
| commit | 5359c011a08ef2e06ed54104cc16c32868ca88ff (patch) | |
| tree | cc644bb54934fb5d1980bd502c6f93e3737505da /docs/using-celeritas.md | |
| parent | f926234600af1883c2be259360b44173bb7c12b4 (diff) | |
docs
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 |