diff options
| author |  Linus Torvalds <torvalds@linux-foundation.org> | 2012-01-01 15:12:28 -0800 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2012-01-01 15:12:28 -0800 |
| commit | 1a83bf43b688dff5fa65afb751e7fdb65026e583 (patch) | |
| tree | 7b227079e4c34ad56fde89166db115cbae6c8bfb /Documentation/Makefile | |
| parent | 1d51c7772996705fb69b2b3433cd94af3543583d (diff) | |
| download | subsurface-1a83bf43b688dff5fa65afb751e7fdb65026e583.tar.gz | |
First try at converting user-manual to AsciiDoc
You can do "make doc" in the main directory to create the html version,
and if you want to play around with it, do "make show" in the
Documentation subdirectory to start firefox on the end result.
It's by no means perfect, but it gives somewhat reasonable results, and
this is enough initial work for people to play around with, I think.
NOTE! You need "asciidoc" installed to do this: it's a python program,
so it should be pretty easy even on non-Linux platforms. And on Linux,
most distributions package it, so you just have to do something like
yum install asciidoc
to get it (replace with apt-get/zypper/whatever).
Asciidoc can generate other output too (man-pages, LaTeX, etc), maybe
people want to play with that part too.
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile new file mode 100644 index 000000000..273eae521 --- /dev/null +++ b/Documentation/Makefile @@ -0,0 +1,10 @@ +ASCIIDOC=asciidoc +BROWSER=firefox + +doc: user-manual.html + +show: user-manual.html + $(BROWSER) user-manual.html + +user-manual.html: user-manual.txt + $(ASCIIDOC) user-manual.txt |