diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-06 12:55:15 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-06 12:55:15 +0200 |
| commit | 02d658a7ed92bacfdaed587102f0d2e5f6c5dc01 (patch) | |
| tree | 1195a0a46b9ce4af470652fecd5c3a3a917c2c58 /src/readme.md | |
| parent | b649adda67ed52c2e3bdcd5aa2cb4b9b0954cf16 (diff) | |
| parent | b5a5d9b1d4725f3001486c9bbd69263ed0918303 (diff) | |
Merge branch 'loek/cleanup' into loek/scripts
Diffstat (limited to 'src/readme.md')
| -rw-r--r-- | src/readme.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/readme.md b/src/readme.md new file mode 100644 index 0000000..1c5d3a2 --- /dev/null +++ b/src/readme.md @@ -0,0 +1,8 @@ +# 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. Unit tests can be built by explicitly +specifying the target `test_main` when running the build command. Each source +file in the example/ folder corresponds to a CMake target as well. + |