From 5359c011a08ef2e06ed54104cc16c32868ca88ff Mon Sep 17 00:00:00 2001 From: omniscient <17525998+omnisci3nce@users.noreply.github.com> Date: Fri, 19 Jul 2024 12:08:41 +1000 Subject: docs --- docs/using-celeritas.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/using-celeritas.md (limited to 'docs/using-celeritas.md') 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//x64/core_static`, etc \ No newline at end of file -- cgit v1.2.3-70-g09d2