From 27994e629b6eb54f61b81e7850b6c2090ef42f46 Mon Sep 17 00:00:00 2001 From: Mathis Brossier Date: Sat, 19 Oct 2024 21:10:06 +0200 Subject: [PATCH] update readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3519f48..49ec789 100644 --- a/README.md +++ b/README.md @@ -90,13 +90,15 @@ Additionally: The code is split into a client, a desktop and a server part. The client generates a static site (html, js, …) that you can host wherever you want or even run locally. The server is a HTTP and WebSocket server that the client connects to. The maps are stored on the server machine. +the server can be installed from cargo: `cargo install twwe-server` + ### Server Have [rust](https://www.rust-lang.org/) and cargo installed. And create a server/maps/ directory with your .map files in it. -Run the server with `RUST_LOG=debug cargo run --release -- --maps ` to run in release mode with debugging info printed to stdout. +Run the server with `twwe-server --maps ` to run in release mode with debugging info printed to stdout. -Use the first command-line argument to change address and port e.g. `cargo run localhost:3333` to run locally on port 3333. +Use the first command-line argument to change address and port e.g. `twwe-server localhost:3333 --maps ...` to run locally on port 3333. Use the `--cert` and `--key` arguments to enable TLS support for websocket. They must point to your PEM certificate and private key.