From 59bcb64fe0399b9121a162c90b713a9f6bea06c5 Mon Sep 17 00:00:00 2001
From: Dominik Werder <dominik.werder@gmail.com>
Date: Wed, 30 Jun 2021 09:10:19 +0200
Subject: [PATCH] Add readme

---
 Readme.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..0e82356
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,42 @@
+# Daqbuffer
+
+DAQ retrieval http API, contains:
+
+* Retrieval http API to run on the nodes of our facilities (backends).
+* Proxy to run on data-api.psi.ch for distribution of requests to facilities.
+
+
+# Build
+
+Tested on RHEL 7 and 8, CentOS 8.
+
+If not yet done, see [Setup Toolchain](#setup-toolchain) first.
+
+Then run in this directory:
+
+```bash
+cargo build --release
+```
+
+Binary is at: `./target/release/daqbuffer`
+
+
+# Setup Toolchain
+
+Install Rust toolchain.
+Quoting from <https://www.rust-lang.org/tools/install> the official installation method:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+This specifically requires a verified TLS connection and then executes the installer.
+
+Installation will by default be done only for your user. No superuser privileges required.
+
+You should have the commands `cargo` and `rustup` now available in your terminal.
+
+
+# License
+
+GNU General Public License version 3 or later.