chiark / gitweb /
improve the README following dependency rationalisation
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 28 Nov 2020 00:44:30 +0000 (00:44 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 28 Nov 2020 00:44:30 +0000 (00:44 +0000)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index 371317504d6c946e3a5b1bcb61ccd04364041621..a71b027350f0fa5ec014f029a1008b86a3f2bc91 100644 (file)
--- 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:<user>::<game-name>
+
+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: