diff options
| author | Colin Reeder <colin@vpzom.click> | 2020-07-18 15:49:45 -0600 |
|---|---|---|
| committer | Colin Reeder <colin@vpzom.click> | 2020-07-18 15:49:45 -0600 |
| commit | 081fef47b6b8750cc744f01f1e5510681e7a9e30 (patch) | |
| tree | ad102eef0d1d6352d7f383278b634ea333f26c75 | |
| parent | 2a708a587e1eb492ec3c1b1b74656d2c80b54438 (diff) | |
Add basic INSTALL.md
| -rw-r--r-- | doc/INSTALL.md | 8 |
1 files changed, 8 insertions, 0 deletions
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`. |