From 081fef47b6b8750cc744f01f1e5510681e7a9e30 Mon Sep 17 00:00:00 2001 From: Colin Reeder Date: Sat, 18 Jul 2020 15:49:45 -0600 Subject: Add basic INSTALL.md --- doc/INSTALL.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 doc/INSTALL.md diff --git a/doc/INSTALL.md b/doc/INSTALL.md new file mode 100644 index 0000000..a05d32f --- /dev/null +++ b/doc/INSTALL.md @@ -0,0 +1,8 @@ +# hitide installation +Requirements: nightly rustc & cargo, openssl, lotide + +Set these environment variables: + - BACKEND_HOST - URL path to lotide + - PORT (optional) - Port number to bind to. Defaults to 4333. + +To build hitide, run `cargo build --release` (note that this currently requires a nightly build of rust, hopefully should be resolved soonish). A `hitide` binary will appear in `./target/release`. -- cgit v1.2.3