aboutsummaryrefslogtreecommitdiff
path: root/src/readme.md
blob: a8ffc51c1ca0a71df1b1186ddaca692017d47c08 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# engine source

This folder contains the crêpe engine source files, unit tests, and some toy
examples. The only target built by default by the CMakeLists.txt in this folder
is the crêpe shared library object.

Examples (using Ninja):

```
$ cmake -B build -G Ninja
$ ninja -C build
```

Unit tests can be built by explicitly specifying the target `test_main` when
running the build command:

```
$ ninja -C build test_main
```

Each source file in the example/ folder corresponds to a CMake target as well
(all examples can be built at once by specifying the `examples` target):

```
$ ninja -C build audio_internal components_internal
```

For installing crêpe system-wide after building (install must be run with
elevated privileges):

```
# ninja -C build install
```