Installation instructions

2023-10-06 08:00:51 +02:00 · 2023-10-06 08:00:51 +02:00 · 829923ed46
parent 5914104002
commit 829923ed46
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -13,3 +13,12 @@ Additional notes:
 - Periodically, empty UDP packets are being sent to avoid NAT timeouts.
 - The number of clients is restricted (to avoid abuse).
 - A small delay is introduced (to avoid abuse).
+
+## Installation
+For compiling m32chat, you only need a recent Rust toolchain. [rustup.rs](https://rustup.rs/) could help you with it.
+
+- After getting the source code, you can compile it with `cargo build --release`.
+- Copy the binary for example to `/usr/local/bin/`.
+- You can use the systemd template for m32chat and adapt it to your needs (i.e. customize the user name under which the service should run).
+
+Setting the environment variable `RUST_LOG=Debug` will give you some debug messages.