chiark / gitweb /
shapelib docs: Mention in README.md
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 13 Jan 2021 01:10:25 +0000 (01:10 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 13 Jan 2021 01:10:25 +0000 (01:10 +0000)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index c775fdf5e702468b51ad3af501cbc4b19b7aa131..77c05a451564625ca2b655b29ed2ad21dfd3e710 100644 (file)
--- a/README.md
+++ b/README.md
@@ -83,12 +83,15 @@ Otter uses SVGs.  The sources for the SVGs are all in the otter source
 tree, in the `library/` directory.
 
 Each shape is listed in one of the `library/*.toml` files, in a
-`files` entry.  Unfortunately the syntax and semantics of this file
-are not yet properly documented.
+`files` entry.  (Most of) the syntax and semantics of this file are
+documented in the Rustdoc documentation for the module
+`otter::shapelib_toml`.  If you run `make -j8 shapelib` it will print
+out a `file://` url for these docs.
 
 You can preview the shapes, including any changes you make, without a
 whole game server, by running `make -j8 shapelib`, and looking at
-`templates/shapelib.html`.  (See BUILDING AND TESTING for information
+`templates/shapelib.html`.  As above, this make rune will print the
+`file://` url for you.  (See BUILDING AND TESTING for information
 about how to install the tools you will need.)
 
 Some of these SVGs were scraped from Wikimedia.  The scraper machinery