summaryrefslogtreecommitdiff
path: root/docs/README
diff options
context:
space:
mode:
authorBernd Zeimetz <bzed@debian.org>2014-08-09 11:41:12 +0200
committerBernd Zeimetz <bzed@debian.org>2014-08-09 11:41:12 +0200
commitfa981bb85662773c5cbe5e1000e1241cf4b5a6d5 (patch)
treeb581bae3a88e382b525d4fe3f0de8ea14a4d95cb /docs/README
Import liblqr_0.4.2.orig.tar.gz
[dgit import orig liblqr_0.4.2.orig.tar.gz]
Diffstat (limited to 'docs/README')
-rw-r--r--docs/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000..9000079
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,25 @@
+LiquidRescale Library Manual
+============================
+
+The library manual is provided in docbook format.
+
+Stylesheets and a makefile are also provided to get html versions and
+manual pages.
+
+*) Issuing `make' or `make html' will produce the manual in html format,
+ with the file `liblqr_manual.html' pointing to the manual index.
+
+*) Issuing `make onepage' will produce the manual in html formal in a single
+ page, under the name `liblqr_manual_onepage.html'.
+
+*) Issuing `make man' will produce the man pages in the directory `man3/'.
+
+However, these assume that `xsltproc' is installed in your system and that
+your docbook specifications are located at:
+
+ html: /usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl
+ onepage: /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/html/docbook.xsl
+ man: /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl
+
+If this is not the case, edit the `lqr_style.xsl', `lqr_style_onepage.xsl'
+and `lqr_style_man.xsl' files accordingly.