summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.md b/README.md
index 64ac0ad6..da8e618a 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,29 @@
[![commit](https://github.com/sthalik/floormat/actions/workflows/cmake.yml/badge.svg)](https://github.com/sthalik/floormat/actions/workflows/cmake.yml)
-### floormat
+# floormat
Game project in early development.
-### Build
+## Build
-Should build cleanly on Clang 17+, GCC 13.2+ and MSVC 17.7. Just make sure to check it out with submodules.
+Should build cleanly on Clang 17+, GCC 13.2+ and MSVC 17.7+.
-### License
+### Debian/Ubuntu dependencies
+`xorg-dev` `libsdl2-dev` `build-essential` `ninja-build` `cmake-curses-gui`
-ISC
+### Windows dependencies
+
+Only the compiler (MSVC, GCC, Clang) is needed.
+
+### Building
+```console
+git clone https://github.com/sthalik/floormat.git
+cd floormat
+git submodule update --init
+mkdir build
+cd build
+cmake -GNinja ../
+ninja install
+ln -s ../doc/saves ./save
+install/bin/floormat-editor
+```