Add instructions for viewing documentation to README

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
index fd6cf08..55cf193 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,17 @@ as seen in the example for the part.
 
 Spork contains third-party dependencies in the `deps/` directory. All dependencies are MIT/X11 licensed, or public domain.
 Licenses for individual components can be found along with the source code in the `deps/` directory.
+
+## Documentation
+
+Spork's documentation is written using [Mendoza](https://github.com/bakpakin/mendoza).
+  The docs are most easily read by first building and then serving the .mdz files in `doc/` using Mendoza.
+  You can then access the served static site using a browser.
+
+- First, make sure you have [Janet](https://janet-lang.org/) and [jpm](https://janet-lang.org/docs/jpm.html) installed. See [the Janet docs](https://janet-lang.org/introduction.html) for more information on this.
+- Next, install Mendoza (to install globally, run `[sudo] jpm install mendoza`). For more information on Mendoza, see [the Mendoza project on GitHub](https://github.com/bakpakin/mendoza).
+- Clone this repo locally (e.g. using `git clone https://github.com/janet-lang/spork.git`).
+- From the spork project root (`cd spork` if you just cloned it) run `mdz build && mdz serve`.
+
+While the Mendoza server process is running, you can navigate to http://localhost:8000 to view the spork docs as a static site.
+