diff options
| author | Nico Weber <nicolasweber@gmx.de> | 2016-04-27 19:17:10 (GMT) |
|---|---|---|
| committer | Nico Weber <nicolasweber@gmx.de> | 2016-04-27 19:17:10 (GMT) |
| commit | a60702e1b0a4f108e16bb4c03f7fd1c821e5ad1d (patch) | |
| tree | 096eff77f63235157d529d749cc6d67199856f1d /doc/README.md | |
| parent | 484c16336f19bd8970bb6e75322d61b92a229899 (diff) | |
| parent | 06b0e568f62d228837e96c485447f55da1ae9b5d (diff) | |
| download | Ninja-a60702e1b0a4f108e16bb4c03f7fd1c821e5ad1d.zip Ninja-a60702e1b0a4f108e16bb4c03f7fd1c821e5ad1d.tar.gz Ninja-a60702e1b0a4f108e16bb4c03f7fd1c821e5ad1d.tar.bz2 | |
v1.7.0v1.7.0
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..6afe5d4 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,11 @@ +This directory contains the Ninja manual and support files used in +building it. Here's a brief overview of how it works. + +The source text, `manual.asciidoc`, is written in the AsciiDoc format. +AsciiDoc can generate HTML but it doesn't look great; instead, we use +AsciiDoc to generate the Docbook XML format and then provide our own +Docbook XSL tweaks to produce HTML from that. + +In theory using AsciiDoc and DocBook allows us to produce nice PDF +documentation etc. In reality it's not clear anyone wants that, but the +build rules are in place to generate it if you install dblatex. |