chiark / gitweb /
docs: build.rst: Section for how to build just the cli
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 9 Jun 2021 16:47:46 +0000 (17:47 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 10 Jun 2021 12:48:54 +0000 (13:48 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
docs/build.rst

index 6bf0eca02cb81d4229e87ba52640ba54e610a7f6..d90eb5af0a6ceb4fe79bf09c5b199b6c61d80e06 100644 (file)
@@ -61,8 +61,8 @@ Setup
    and just dump the resulting ``geckodriver`` binary on your ``PATH``.
 
 
-Build
------
+Full build
+----------
 
 ::
 
@@ -73,6 +73,20 @@ Build
 Expect to see ``it worked`` at the end.  If you don't see that, it
 failed, and the error message is buried in the scrollback.
 
+Build just the command line game management client `otter`
+..........................................................
+
+::
+     cargo build -p otter-cli
+
+and then copy ``target/debug/otter`` onto your path.
+
+Alternatively, you can let ``cargo`` directly install and download the
+latest released version:
+
+::
+     cargo install otter-cli
+
 Build just the shape library preview
 ....................................