aboutsummaryrefslogtreecommitdiff
path: root/doc/README
diff options
context:
space:
mode:
authorNIIBE Yutaka <gniibe@fsij.org>2013-08-21 11:18:27 +0900
committerNIIBE Yutaka <gniibe@fsij.org>2013-08-21 11:18:27 +0900
commitcbbd81ce47d78a19cead7d88707c705773165825 (patch)
treeab69672f5ae5fd46aaef11b16c6ed7678df200f4 /doc/README
parent46f1558dedbca3d0c62c91b08334ff66cf6cf03a (diff)
Add doc
Diffstat (limited to 'doc/README')
-rw-r--r--doc/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..47b0d6e
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,13 @@
+The GDOC script is taken from:
+
+ http://git.savannah.gnu.org/cgit/libidn.git/plain/doc/gdoc
+
+and then modified %highlights_texinfo to use @var for parameters.
+
+The file 'chopstx-api.texi' is generated by:
+
+ $ ./gdoc -texinfo ../chopstx.c >chopstx-api.texi
+
+Then, we generate chopstx.info by:
+
+ $ makeinfo -o chopstx.info chopstx.texi