Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve contribution instructions

  • Loading branch information...
commit 8a1596727edb4ad973c7ab25eff13f0bba23a9b0 1 parent 5652d83
@pmuir pmuir authored
Showing with 5 additions and 3 deletions.
  1. +4 −2 CONTRIBUTING.md
  2. +1 −1  generate-guides.sh
View
6 CONTRIBUTING.md
@@ -1,8 +1,10 @@
Contributing to the TicketMonster tutorial
==========================================
-Each section of the tutorial is contained in a `.asciidoc` file in this git repository. To build the tutorial you'll need [AsciiDoc](http://www.methods.co.nz/asciidoc/index.html) installed. It's available via most major packaging systems (e.g. Debian, Fedora Extra, MacPorts), and has a Windows installer.
+Each section of the tutorial is contained in a `.asciidoc` file in this git repository. To build the tutorial you'll need:
-You'll also need pygments for syntax highlighting. It's available as a python egg.
+* [AsciiDoc](http://www.methods.co.nz/asciidoc/index.html) installed. It's available via most major packaging systems (e.g. Debian, Fedora Extra, MacPorts), and has a Windows installer.
+* You'll also need pygments for syntax highlighting. It's available as a python egg. Easiest to install via `easy_install` e.g. `sudo easy_install pygments`.
+* dblatex, once again available in most major packaging systems, or as a python egg e.g. `sudo easy_install dblatex`
Once you have installed AsciiDoc, you can build individual sections by invoking `asciidoc -b <output of choice> <section.txt>`. If you want to generate the whole tutorial as html, you can call `./generate-guides.sh`.
View
2  generate-guides.sh
@@ -28,7 +28,7 @@ mkdir -p $TARGET
files=`find * -iname \*.asciidoc`
element_count=${#OUTPUT_FORMATS[@]}
-for ((i=0; i <= $element_count; i++))
+for ((i=0; i < $element_count; i++))
do
output_format=${OUTPUT_FORMATS[i]}
dir=$TARGET/$output_format
Please sign in to comment.
Something went wrong with that request. Please try again.