From 870075f34dd9fa5792bfbf413afd3b96f17e76a0 Mon Sep 17 00:00:00 2001
From: Stephane Glondu <steph@glondu.net>
Date: Fri, 8 Aug 2008 13:18:42 +0200
Subject: Imported Upstream version 8.2~beta4+dfsg

---
 INSTALL.doc | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 INSTALL.doc

(limited to 'INSTALL.doc')

diff --git a/INSTALL.doc b/INSTALL.doc
new file mode 100644
index 00000000..3eb72e08
--- /dev/null
+++ b/INSTALL.doc
@@ -0,0 +1,81 @@
+                           The Coq documentation
+                           =====================
+
+The Coq documentation includes 
+
+- A Reference Manual
+- A Tutorial
+- A document presenting the Coq standard library
+- A list of questions/answers in the FAQ style
+
+The sources of the documents are mainly made of LaTeX code from which
+user-readable PostScript or PDF files, or a user-browsable bunch of
+html files are generated.
+
+Prerequisite
+------------
+
+To produce the PostScript documents, the following tools
+are needed:
+
+  - latex (latex2e)
+  - dvips
+  - bibtex
+  - makeindex
+  - pngtopnm and pnmtops (for the Reference Manual and the FAQ)
+
+To produce the PDF documents, the following tools are needed:
+
+  - pdflatex
+  - bibtex
+
+To produce the html documents, the following tools are needed:
+
+  - hevea (e.g. 1.07 works)
+
+Compilation
+-----------
+
+To produce all documentation about Coq, just run:
+
+   make doc
+
+
+Alternatively, you can use some specific targets:
+
+   make doc-ps 
+   	to produce all PostScript documents
+
+   make doc-pdf
+        to produce all PDF documents
+
+   make doc-html
+        to produce all html documents
+
+   make refman
+        to produce all formats of the reference manual
+
+   make tutorial
+        to produce all formats of the tutorial
+
+   make rectutorial
+        to produce all formats of the tutorial on recursive types
+
+   make faq
+        to produce all formats of the FAQ
+
+   make stdlib
+   	to produce all formats of the Coq standard library 
+
+
+Installation
+------------
+
+To install all produced documents, do:
+
+  make DOCDIR=/some/directory/for/documentation install-doc
+
+DOCDIR defauts to /usr/share/doc/coq-x.y were x.y is the version number
+
+
+
-- 
cgit v1.2.3