add readme

This commit is contained in:
Florian Lüke 2024-12-28 18:43:02 +01:00
parent 9706a19e56
commit 430c812a15

19
README.md Normal file
View file

@ -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 .
```