From ac27bae55a3a2ab7f77ba1376a5fbb82c2c61aec Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 13 Jan 2021 01:10:25 +0000 Subject: [PATCH] shapelib docs: Mention in README.md Signed-off-by: Ian Jackson --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c775fdf5..77c05a45 100644 --- 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 -- 2.30.2