summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2025-12-20 15:18:15 +0100
committerxengineering <me@xengineering.eu>2025-12-20 15:18:15 +0100
commit71ffe1112b2d1312157c42b90908fb4cdb6308b5 (patch)
treebace4dd81f153fca293a89e4f4c20c6d479bff69
parentf2e6dee6000258c95b5e0e52a9e17fafc35f6a5b (diff)
downloadsia-server-71ffe1112b2d1312157c42b90908fb4cdb6308b5.tar
sia-server-71ffe1112b2d1312157c42b90908fb4cdb6308b5.tar.zst
sia-server-71ffe1112b2d1312157c42b90908fb4cdb6308b5.zip
README.md: Add build instructions
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index eaa4841..18d4b91 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,24 @@ The currently only supported device is:
Further device support is planned.
+## Build instructions
+
+The Sia server is built and tested with the Meson build automation tool.
+
+```
+meson setup build
+meson compile -C build
+meson test -C build
+```
+
+Build artefacts can be shown with the `tar` archive tool and `less` pager.
+
+```
+tar -tf build/sia-server-v*.tar.zst | less
+```
+
+All relevant build results are part of this Zstandard-compressed tar archive.
+
[1]: https://homematic-ip.com/
[2]: https://openccu.de/
[3]: https://homematic-ip.com/en/product/window-and-door-contact-optical