From f597be870eec6d04de6bed0effa7dd23bcb72bf8 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Thu, 11 Jul 2024 13:17:03 +0200
Subject: initial commit

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c59ca3c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+turns
+=====
+
+*turns* is a simple turn-order tracker for use with tabletop role-playing games.
+
+Building from source
+--------------------
+
+bookie depends on the following libraries:
+  - `catch2` >= 3.6
+  - `gtkmm-4.0` >= 4.14
+  - `libadwaita` >= 1.5
+
+and tools:
+  - `cmake` >= 3.29
+  - `gcc` >= 14.1
+  - `ninja` >= 1.11
+  - `pkgconf`
+
+Once all dependencies are installed, the project can be built using the following command:
+
+```bash
+$ cmake --workflow --preset debug
+```
+
+to create a debug build, or:
+
+```bash
+$ cmake --workflow --preset minsizerel
+```
+
+to create a release build.
-- 
cgit v1.2.3