From e85bf2c4e5f8c3c2d6e58ea0c8283a78f4b783a7 Mon Sep 17 00:00:00 2001 From: Derek Stevens Date: Wed, 4 Aug 2021 23:20:16 -0600 Subject: [PATCH] update README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9034fb4..d95940e 100644 --- a/README.md +++ b/README.md @@ -57,21 +57,24 @@ The realm should be synchronized to disc when realm membership, limit, or passwo ## build/run -`xrxs` is built/tested in a Linux environment with `plan9port` and the C standard library as the only dependencies. With minimal modifications it will probably run just as well on *BSD, WSL, and MacOS. +`xrxs` is built/tested in a Linux environment with `plan9port` and the C standard library as the only dependencies. With minimal modifications it will probably run just as well on Plan9, *BSD, WSL, and MacOS. Running `./build.sh` from the repository root should build the `xrxs` executable. You can run a local server (for testing, split-screen games, or single-player games) with: + ``` ./xrxs -m /path/to/mountpoint ``` or expose a service on the network (uses `9pserve` to support multiple users and gracefully handle disconnects) with: + ``` ./xrxs-srv.sh start ``` Similarly, you can stop the service with: + ``` ./xrxs-srv.sh stop ```