From ae0cbafb0202355973572e208c75591d12c2250c Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Wed, 1 May 2024 16:14:04 +0200
Subject: Add build instructions to README.md

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index 69d6c8b..d5e7280 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,24 @@
 # Ceres - Recipe server for local networks
 
+## Build instructions
+
+The following build dependencies are required:
+
+- [Git][2]
+- [Go][4]
+- [GNU Make][3]
+
+On Linux Ceres can be build like this:
+
+```
+git clone https://cgit.xengineering.eu/ceres
+cd ceres
+make
+```
+
+The `ceres` executable is placed in the `build` folder which can be removed by
+calling `make clean`.
+
 ## API definition for Semantic Versioning
 
 Ceres uses Semantic Versioning as defined by [semver.org][1]. This requires to
@@ -12,3 +31,6 @@ define a "public API". These aspects of Ceres together form the public API:
 As soon as version 1.0.0 is reached these aspects are stable.
 
 [1]: https://semver.org
+[2]: https://git-scm.com
+[3]: https://www.gnu.org/software/make
+[4]: https://go.dev
-- 
cgit v1.2.3-70-g09d2