aboutsummaryrefslogtreecommitdiff
path: root/doc/BUILDING.md
diff options
context:
space:
mode:
authorElias Fleckenstein <eliasfleckenstein@web.de>2021-06-14 11:10:58 +0200
committerElias Fleckenstein <eliasfleckenstein@web.de>2021-06-14 11:10:58 +0200
commita084f521e94bba28c4c2f3ecee8e9912f87c20d7 (patch)
tree6585fe8656aed7dc10797fe7ad0264d4cce73af6 /doc/BUILDING.md
parent3432efe82387a6a4145d087c4af1a354d4063901 (diff)
downloaddungeon_game-a084f521e94bba28c4c2f3ecee8e9912f87c20d7.tar.xz
Split documentation into multiple files and document gameplay
Diffstat (limited to 'doc/BUILDING.md')
-rw-r--r--doc/BUILDING.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/BUILDING.md b/doc/BUILDING.md
new file mode 100644
index 0000000..87d1f0a
--- /dev/null
+++ b/doc/BUILDING.md
@@ -0,0 +1,7 @@
+# Building
+
+The loader needs GCC to compile (`__USE_GNU`).
+
+To build the loader and the plugins in the plugins/ folder, simply type `make` or `make all`. There are separate targets for the loader (`dungeon`) and the plugins.
+To run the loader, type `./dungeon`. It will load all plugins including the game itself dynamically and run the game.
+