X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=9a277eade36057275d260dd853dd82ef45c5b396;hb=91a0f4fd6d6f0197a26f3d8b161eefacd685fabe;hp=16b999b1fdaa5a95ef8ec597f82fc2f6242c8646;hpb=c6b970506e5986636f1411b8cfffcd98312a861f;p=ardour-manual-diverged diff --git a/README.md b/README.md index 16b999b..9a277ea 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ This is the project that generates the static ardour manual website available at The site is built using ruby (I use 1.9[.3]) and [Jekyll](https://github.com/mojombo/jekyll) (a ruby gem). You should be able to just install ruby and then `gem install jekyll` to get it up and running. -`import.rb` (which gets the content from drupal) requires the `nokogiri` gem, but there are no other dependencies for the jekyll part (just the things required by jekyll itself). - ### Get the code git clone @@ -101,25 +99,10 @@ notes just in case you decide to anyway. This will generate the final html and start a local webserver. - jekyll --server + jekyll serve It should then be available at [localhost:4000](http://localhost:4000) -### Import content from drupal - -This will pull the content from the [ardour drupal manual](http://ardour.org/manual/ardour3) and turn it into the format used in `_manual/`. You shouldn't really need to run this. - - ruby import.rb - -It's quite slow… :) - - -### Upload static site to live server - -Once the content has been built (using jekyll) you can put it live with this (assuming your ssh key has been put on the server): - - ./upload.sh - ### manual.rb plugin Much of the functionality comes from `_plugins/manual.rb` - it takes the _manual format_ (contained in `_manual/`) and mushes it around a bit into a tmp directory before letting jekyll do it's normal thing. It's all hooked into the jekyll command so no special actions are required.