aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/README.documentation
diff options
context:
space:
mode:
authorGravatar David Aspinall <da@inf.ed.ac.uk>2004-02-29 21:24:48 +0000
committerGravatar David Aspinall <da@inf.ed.ac.uk>2004-02-29 21:24:48 +0000
commit5509246fe0099efb13541a420191f0408a83ae5c (patch)
treed78db49d61f6f1e434196551c2d4974afb89c753 /doc/README.documentation
parent189ae3c0fb18dba26462dee590d6a7949ceae5d8 (diff)
Renamed file
Diffstat (limited to 'doc/README.documentation')
-rw-r--r--doc/README.documentation38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/README.documentation b/doc/README.documentation
new file mode 100644
index 00000000..204f1c24
--- /dev/null
+++ b/doc/README.documentation
@@ -0,0 +1,38 @@
+Proof General Documentation
+===========================
+
+The distribution may include pre-built documentation for
+your convenience. Otherwise you will need to run
+
+ make info
+ make dvi
+ make pdf
+ make html
+
+according to what format you'd like. Everything is generated
+from the master Texinfo files ProofGeneral.texi and PG-adapting.texi,
+so you'll need the proper tools for conversion. Check Makefile.doc
+for details.
+
+Front Image for Manual
+----------------------
+If you want a front image on the printed dvi/gs manuals, you need to
+have the ProofGeneral.eps file in this directory. You can download a
+compressed version from
+
+ http://proofgeneral.inf.ed.ac.uk/ProofGeneralPortrait.eps.gz
+
+This file is not included with the distribution because it is rather
+large (1.6M).
+
+Instead of downloading, you may be able to generate an alternative eps
+from the included ProofGeneral.jpg file using an image manipulation
+program such as gimp or Imagemagick. This will give you a slightly
+different (and degraded) image compared to the distributed one
+mentioned above.
+
+Running "made dvi" will adjust the Texinfo file to make the front
+page blank if there is no ProofGeneral.eps file available.
+
+David Aspinall.
+August 2000.