summaryrefslogtreecommitdiff
path: root/docs/using-celeritas.md
blob: ceb3b7c54c60534d2736b9c30d07ebb1008122d9 (plain)
1
2
3
4
5
6
7
8
9
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