chiark / gitweb /
docs: Headings
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 8 Apr 2021 18:26:33 +0000 (19:26 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 8 Apr 2021 19:34:21 +0000 (20:34 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md
docs/advanced.md
docs/user.md

index be94387e539eac6431f1c84e6af649cf52bdf718..e7fe5c47deecb2fe775d1f0936e6c8d2756b613e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
-OTTER - ONLINE TABLE TOP ENVIRONMENT RENDERER
-=============================================
+Introduction
+============
 
-Otter is an online game system.
+Otter, the Online Table Top Environment Renderer, is an online game
+system.
 
 But it is not like most online game systems.  It does not know (nor
 does it need to know) the rules of the game you are playing.  Instead,
@@ -37,7 +38,7 @@ Mao with Otter.
 
 
 Playing a game with Otter
---------------------------
+-------------------------
 
 The Otter game environment is accessed from a web browser running
 JavaScript, using a magic https link obtained from joining the game.
index a0f4620f63e7680433f0a0be831cf2353d6ec8c2..c5d0dcfc48c4ac2e26f345c3da44de27c507c3e7 100644 (file)
@@ -1,5 +1,18 @@
-Making your own game
-====================
+Advanced usage
+==============
+
+Adding pieces to a game in progress
+-----------------------------------
+
+Use the `otter library-list` and `otter library-add` commands, you can
+add pieces to a game while it is in progress.
+
+You may want to refer to the shape library preview ("Shapelib" link in
+the game UI).
+
+
+Defining your own game
+----------------------
 
 If you want to use existing piece shapes that Otter already knows
 about, you can do this by providing a `<something>.game.toml` file.
@@ -7,8 +20,8 @@ The format of these files is a TOML document representing a `GameSpec`
 as found in `src/spec.rs` in the Otter source code.
 
 
-Adding shapes
-=============
+Adding shapes (pieces, cards, etc.)
+-----------------------------------
 
 Otter uses SVGs.  The sources for the SVGs are all in the otter source
 tree, in the `library/` directory.
index 724fe7394b457b2bef2f35ae0d1e56580937ba29..f65259f0b01e9786302556ee2e511569b32cd485 100644 (file)
@@ -1,5 +1,5 @@
-OTTER - USER DOCUMENTATION
-==========================
+Using Otter as a player or game host
+====================================
 
 Basics; joining a game
 ----------------------