summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 662407e..72c6ae7 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,9 @@ This repo serves as testing grounds for feature development of the daw engine.
Building requirenments are the same as the engine itself, ie. assimp, glad,
glfw, and stb.
+I strive to keep this branch as compatible as possible with the latest version
+of the [engine](https://codeberg.org/onelin/daw).
+
building currently requires building as shared library / debug build:
```
@@ -12,7 +15,10 @@ cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build
```
-running:
+You can replace "Debug" with "Release" for a release version.
+
+Because the debug build uses hot reloading, we need to set `LD_LIBRARY_PATH` to
+our build folder before running:
```
LD_LIBRARY_PATH=build ./build/rogue
```