From 430c812a152d70bffb1bfc8d0d09d04a2d8b2dd1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20L=C3=BCke?= <f.lueke@mesytec.com>
Date: Sat, 28 Dec 2024 18:43:02 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8abe12f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# mesytec-mnode
+
+## How to build
+
+protobuf is required. Use the same compiler for protobuf and mesytec-mnode.
+
+```bash
+git clone --depth 1 https://github.com/protocolbuffers/protobuf --branch v3.29.2 --shallow-submodules --recurse-submodules=third_party/abseil-cpp
+mkdir -p protobuf/build && cd protobuf/build && cmake -GNinja -DCMAKE_BUILD_TYPE=Release -Dprotobuf_BUILD_TESTS=OFF -DCMAKE_INSTALL_PREFIX=~/local/protobuf .. && cmake --build . -j && cmake --install .; cd -
+export CMAKE_PREFIX_PATH=~/local/protobuf
+```
+
+git clone mesytec-mnode and cd into it.
+
+```bash
+cd mesytec-mnode
+git submodule update --init --recursive
+mkdir build && cd build && cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/local/mesytec-mnode .. && cmake --build . -j && ctest . && cmake --install .
+```