Kill Bill documentation
Ruby Shell JavaScript
Latest commit d1c39ef Jan 11, 2017 @sbrossie sbrossie committed on GitHub Update overdue.adoc

README.md

killbill-docs

Kill Bill documentation (user guides and tutorials).

To generate the documentation locally, run make.sh. Generated html files are in the build directory (only selfcontained HTML files are generated today).

Pages are automatically built and pushed to http://killbill.github.io/killbill-docs by Travis.

Setup

The scripts assume the asciidoctor gem (v 0.1.4) is installed: gem install asciidoctor -v 0.1.4.

Documentation on AsciiDoc can be found here. A quick reference is available here.

How to contribute

  • Make sure to work off branch v3
  • Install the gem dependencies: gem install asciidoctor --version=1.5.2; gem install asciidoctor-diagram --version=1.3.2; gem install pygments.rb --version=0.6.3