= Documentation README

The documentation of PacketFence is formatted in http://www.methods.co.nz/asciidoc/[AsciiDoc].

To convert the documentation to the PDF or HTML format, you need various tools:

* https://asciidoctor.org/[asciidoctor] (.asciidoc to .html)
* https://asciidoctor.org/docs/asciidoctor-pdf/[asciidoctor-pdf] (.asciidoc to .pdf)
* https://github.com/rouge-ruby/rouge[rouge] (syntax highlighter)

The Makefile at the root of the repository will call those tools:

* To generate PDF documents

  make pdf

* To generate HTML documents

  make html

// vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab:
