update README
Iris Lightshard nilix@nilfm.cc
PGP Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEkFh6dA+k/6CXFXU4O3+8IhROY5gFAmELdRAACgkQO3+8IhRO Y5gMLA/9FQYll+jE6fKU742GkVgrg/WbcVwhtM8hQPL3a2jUal9v9oEw1hMmgdrw 3mg2OBGaKm501UJGVHHeHemWXgQUIRV4cAzNozrUsw1pgT/qInOe1YyuIt3zpju6 32rcNkFgGFMJoaQGIQzUWQuXKquoqnPABVfDgyPc4Ghj0zWHlRCa3IuFBaz4E3A9 u5HTaeFV+5K1JY39MhtiQRXafVk6f3vNPBRh/pyRK/bce9rzxK64gl7j8wimMqfT M1jgcfJ5zJJ8TcsUZdcI/xCb5y1rGY7vSVen3GEJXmE7Co3GUoT0MG1k1sBt8s9y INbeCmp+Ns7JzA06bpdmoN4ja3F8ZUxzNeVPKsffsZqUiv+dCYu1tr99o7oBjTks pcV4DNbfV+frlzHUwRbtGx4ObVL1wyYH3qQPja8fJP7dEbVvCN+l9+M+kxLSdWJV 1xAWcugxwn7AsSJ92aaLTNVV7cCCpiAc+SAM/XS2Itgf2IYNOLdQ7GAe+R6n+feT 9yiM+M0zGY79oeqoa+tv7hFBEcIbC+X37BQ9VMNdljEV8CdTyo0/UsfVLSQ1kp9M SNnslSOCkLvTK0ha3LrFHP0soKd4L+iFhoD7JT4UTXiDY/8NCkDaVBZX+A0wnd04 qruwRrsHdFJ0EB3A4AbJDsMiGlAL39utvmy2i7505EJz72HSg3A= =cEuR -----END PGP SIGNATURE-----
1 files changed,
4 insertions(+),
1 deletions(-)
jump to
M
README.md
→
README.md
@@ -57,21 +57,24 @@ * `DATA_DIR`: the path to the root of the cartridge and realm storage; can be absolute or relative to the `xrxs` executable, but must have the trailing `/`
## 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 ```