From: Ian Jackson Date: Sat, 28 Nov 2020 00:44:30 +0000 (+0000) Subject: improve the README following dependency rationalisation X-Git-Tag: otter-0.2.0~308 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=63b9385b3a1ce06d9267c2ad04311f8da5c01257;p=otter.git improve the README following dependency rationalisation Signed-off-by: Ian Jackson --- diff --git a/README.md b/README.md index 37131750..a71b0273 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,18 @@ by the players without help from the Otter server. Right now Otter is in an alpha state. +JOINING A GAME +============== + +In the simplest case: + otter join-game unix::: + +See otter --help for further options, including setting your nick. + +Currently when a new player joins a game (with the `otter` command), +all the other players must restart. + + CREATING A GAME =============== @@ -79,11 +91,10 @@ branch You cannot build it just with `cargo`, you must use `make`. -You will also need various other utilities and dependencies - in some -cases, un-released dependencies or locally patched versions. See -`Cargo.nail` and `Makefile`. On my own laptop deployment is done with -`make deploy` which copies all the relevant sources into the -`bundled-sources` directory, which is accessible via the Otter web UI. +You will also need various other utilities and dependencies. See +below. On my own laptop deployment is done with `make deploy` which +copies all the relevant sources into the `bundled-sources` directory, +which is accessible via the Otter web UI. See the code in `Makefile`. Dependencies ------------ @@ -109,16 +120,6 @@ Dependencies Weirdnesses: - * `Cargo.nail` contains a list of sibling directories of my Otter - source tree, which on my machine is called `server`. For several - of these I sent patches upstream which have generally been - accepted, but I need to tidy this up to switch to the upstream - version. - - * The Rocket dependency in `Cargo.toml` is completely mad due - to Cargo being awful. I am hoping I can switch to an upstream - Rocket now. - * For running on chiark I build with the Rust target `x86_64-unknown-linux-musl` which on my system is configured to produce a completely statically linked bionary: