~vpzom/hitide

081fef47b6b8750cc744f01f1e5510681e7a9e30 — Colin Reeder 1 year, 8 days ago 2a708a5
Add basic INSTALL.md
1 files changed, 8 insertions(+), 0 deletions(-)

A doc/INSTALL.md
A doc/INSTALL.md => doc/INSTALL.md +8 -0
@@ 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`.