| 1 | The LTTng Documentation: Source |
| 2 | =============================== |
| 3 | |
| 4 | This is the official repository of the |
| 5 | http://lttng.org/docs[online LTTng Documentation's] source. |
| 6 | |
| 7 | |
| 8 | == Generate |
| 9 | |
| 10 | You can generate your own version of the LTTng Documentation by running: |
| 11 | |
| 12 | ---- |
| 13 | make |
| 14 | ---- |
| 15 | |
| 16 | The generated HTML file is named |
| 17 | +__VERSION__/lttng-docs-__VERSION__.html+, where +__VERSION__+ is the |
| 18 | version of the LTTng project documented by this file. |
| 19 | |
| 20 | You can also make a specific version: |
| 21 | |
| 22 | ---- |
| 23 | make 2.7 |
| 24 | ---- |
| 25 | |
| 26 | NOTE: The SVG animations rendered on the LTTng website are not |
| 27 | available in the generated version. |
| 28 | |
| 29 | You need the following tools to generate the LTTng Documentation: |
| 30 | |
| 31 | * http://www.methods.co.nz/asciidoc/[AsciiDoc] >= 8.6.5 |
| 32 | * http://pygments.org/[Pygments] and the `pygmentize` command |
| 33 | |
| 34 | |
| 35 | == Contribute |
| 36 | |
| 37 | To contribute: |
| 38 | |
| 39 | . Fork this repo. |
| 40 | . Make your change, following the link:CONTRIBUTING.adoc[contributor's guide]. |
| 41 | . Create a pull request. |
| 42 | |
| 43 | Thanks for your contributions and fixes! |