From 552a0a91f5b8450441e5160e50cca80e368525f4 Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Fri, 11 Nov 2022 19:44:29 +0100
Subject: Add documenatation for building and running

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 9d3812e..c79a647 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,30 @@ does not need to provide a password.
 Finally you can quit the MariaDB shell with CTRL + d.
 
 
+## Build and run Ceres
+
+If you just cloned the repository it is important to initialize Git submodules
+to add dependencies via `git submodule update --init`.
+
+Then it is time to build and run Ceres for the first time! If your database is
+correctly configured and your current user has access rights, it is very simple
+to run the server in debug mode:
+
+```
+	make debug
+```
+
+In addition you can also build the server executable with `make all`. The
+result is in the build folder and can be run with:
+
+```
+	./build/ceres -c config/debug.json
+```
+
+The used `config/debug.json` config file is only for debugging. If you want to
+run it as a server, have a look at the `config/default.json` file.
+
+
 [1]: https://xengineering.eu/git/ceres
 [2]: ./CHANGELOG.md
 [3]: https://mariadb.com/
-- 
cgit v1.2.3-70-g09d2