X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=90deb8f5887c3a7bb75582862783bca1806a5f90;hb=8e3b4c710683de8f44cc46d5f00d9e19c0855527;hp=dadce20797258e5265483636324640963430f53f;hpb=33c301104caebd44a7aa6fd09d563fc8f622764d;p=ardour-manual-diverged diff --git a/README.md b/README.md index dadce20..90deb8f 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,8 @@ Content processing is applied to normal content if it has the correct header as Three types of content can have special processing done. - `.html` liquid/HTML files -- `.md` markdown files -- `.textile` textile files +- `.md` markdown files (NOPE!) +- `.textile` textile files (NOPE!) All files to be processed should also have a special header at the top too: @@ -113,6 +113,7 @@ internet access. You will need `git`, `ruby`, and the ruby gem `liquid` installe 2. open `ardour-manual/_site/index.html` in your favorite web browser If this page doesn't open and function correctly, follow these optional steps to serve up the page with nginx. + N.B.: Step 2 will *never* work; you *must* install nginx if you want to see it! 3. Install [nginx](http://wiki.nginx.org/Install) 4. Configure nginx server block in `/etc/nginx/sites-available/default` @@ -147,6 +148,18 @@ E.g. `02_main/05_more/02_blah.html` after all processing is complete would end u The page format contained in the `_manual/` directory is different to the final rendered output (see special `_manual` content above) to make it simple to create content (you don't need to think about the `index.html` files). +### New Stuff +The above will have to be revised eventually, but for now, here's what's what: + +1. A little C helper program needs to be built and run. To build it, do: + + gcc munge.cpp -o munge -lstdc++ -g + +2. Run the 'doit' script: + + ./doit + +3. Now _site should contain the correct built site. Have fun! ;-)