nilix/xrxs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Iris Lightshard 2021-08-04 23:20:16 -06:00
parent bf7aaa6038
commit e85bf2c4e5
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -57,21 +57,24 @@ The realm should be synchronized to disc when realm membership, limit, or passwo
## build/run ## 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. 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: You can run a local server (for testing, split-screen games, or single-player games) with:
``` ```
./xrxs -m /path/to/mountpoint ./xrxs -m /path/to/mountpoint
``` ```
or expose a service on the network (uses `9pserve` to support multiple users and gracefully handle disconnects) with: or expose a service on the network (uses `9pserve` to support multiple users and gracefully handle disconnects) with:
``` ```
./xrxs-srv.sh start ./xrxs-srv.sh start
``` ```
Similarly, you can stop the service with: Similarly, you can stop the service with:
``` ```
./xrxs-srv.sh stop ./xrxs-srv.sh stop
``` ```