README.md

   1 OTTER - ONLINE TABLE TOP ENVIRONMENT RENDERER
   2 =============================================
   3
   4 Otter is an online "table simulator" intended to be suitable for board
   5 games and similar.
   6
   7 It is accessed from a web browser running JavaScript.  The server runs
   8 on a convenationl Unix host.  Currently, joining a game requires a
   9 unix shell account on the server.
  10
  11 Right now Otter is in an alpha state.
  12
  13
  14 BUILDING
  15 ========
  16
  17 Otter is not so easy to build.  You will want to start with the git
  18 branch
  19   https://salsa.debian.org/iwj/otter
  20
  21 You cannot build it just with `cargo`, you must use `make`.
  22
  23 You will also need various other utilities and dependencies - in some
  24 cases, un-released dependencies or locally patched versions.  See
  25 `Cargo.nail` and `Makefile`.  On my own laptop deployment is done with
  26 `make deploy` which copies all the relevant sources into the
  27 `bundled-sources` directory, which is accessible via the Otter web UI.