aboutsummaryrefslogtreecommitdiff
path: root/src/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-10-05 14:16:57 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-10-05 14:16:57 +0200
commitf4bb6d57cc88a7e25b3a5f43faafa49a7f500b7c (patch)
treebe9be8157c10599f572d20113795dc14c620a292 /src/readme.md
parent65eda52aa51017f6f7aad158c4f8b6e91054cf0d (diff)
restructure unit tests and dummies
Diffstat (limited to 'src/readme.md')
-rw-r--r--src/readme.md8
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.
+