mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

First try at converting user-manual to AsciiDoc

Browse source 
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>
This commit is contained in:
Linus Torvalds 2012-01-01 15:12:28 -08:00
parent 1d51c77729
commit 1a83bf43b6
3 changed files with 282 additions and 216 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Documentation/Makefile Normal file
View file

@ -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