X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=b98b0336088118a7b6e9773bbc7f216e94272ea6;hb=9f38cbc6fc5d3b4d574193683c0ada067fa382f3;hp=6a86a03c2eaef6f93a06acac80322e3a166242a0;hpb=6347ad9d3428aaf69c1edbf945563339f2fd29a1;p=ardour-manual diff --git a/README.md b/README.md index 6a86a03..b98b033 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Here are the keywords you can put in, and a brief description of what they do: | ------- | -------- | | title | Sets the title for the content that follows | | menu_title | Sets the title for the content that follows which will appear in the menu link sidebar. If this is not specified, it defaults to the value of the `title` keyword | -| part | Sets the hierarchy for the content that follows. It must be one of the following (listed in order of lowering hierarchy): part, chapter, subchapter | +| part | Sets the hierarchy for the content that follows. It must be one of the following (listed in order of lowering hierarchy): part, chapter, subchapter, section, subsection | | link | Sets the unbreakable link to the content that follows. Links in the *content* should be prefixed with a double at-sign (@@) to tell the build system that the link is an internal one | | include | Tells the build system that the content lives in an external file; these normally live in the `include/` directory. Note that the filename should **not** be prefixed with `include/` | | exclude | Tells the `implode` and `explode` scripts that file referred to by the `include` keyword should be ignored. Note that the value of this keyword is ignored | @@ -81,7 +81,7 @@ notes just in case you decide to anyway. ### Run it locally You may want the manual available on a machine that doesn't have constant -internet access. You will need `git`, and `python3` installed. +internet access. You will need `git`, `python3` and `cherrypy` python module installed. 1. Download code and build manual @@ -91,29 +91,14 @@ internet access. You will need `git`, and `python3` installed. ./build.py ``` -2. Install and configure a web server on your machine. Any web server should -work, Apache, nginx, etc... The following steps are for nginx, using another -server means following the same procedure for the server you decide to use. - -3. Install [nginx](http://wiki.nginx.org/Install) - -4. Configure nginx server block in `/etc/nginx/sites-available/default` - +2. Run the following: ``` - server { - listen 80; - server_name localhost; - - root ...path_to_.../ardour-manual/website; - index index.html; - } + ./servit.py ``` -5. Restart nginx server - - service nginx restart +3. The manual will now be available at http://127.0.0.1:8080 -6. The manual will now be available at http://localhost + (Ctrl-c to quit the server). ### Helper scripts: `implode` and `explode`