*README: New file.

2005-02-24 05:26:33 +00:00
parent 4c6344923e
commit f6dbe3872a
2 changed files with 34 additions and 0 deletions
--- a/winsup/doc/README
+++ b/winsup/doc/README
@@ -0,0 +1,30 @@
+The cygwin-doc source files are kept in CVS. Please see
+http://cygwin.com/cvs.html for more information.
+
+BUILD REQUIREMENTS:
+
+ash
+bzip2
+coreutils
+cygwin
+docbook-xml42
+docbook-xsl
+gzip
+make
+texinfo
+perl
+xmlto
+
+
+OTHER NOTES:
+
+You may use docbook2X to convert the DocBook files into info pages.
+I have not been able to get a working docbook2X installation on Cygwin,
+so currently I convert the files on a machine running GNU/Linux. PDF
+generation is also problematic; I use 'jw -b pdf' right now but have
+also used 'xmlto pdf' and jade.
+
+A few handmade files (cygwin.texi, intro.3, etc.) are found in the
+cygwin-doc-x.y-z-src.tar.bz2 package. It also contains the utilities for
+building the cygwin-doc-x.y-z "binary" package--simply run each step in
+the cygwin-doc-x.y-z.sh script.