forked from TeamSPoon/swipl-devel-unstable
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.doc
40 lines (30 loc) · 1.45 KB
/
README.doc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Building the documentation
--------------------------
Last update: Jan 27, 2011
As of SWI-Prolog 5.6.60, the generated documentation files are no longer
part of the GIT repository (see README.git). There are many ways to
access documentation:
1) Read it online at http://www.swi-prolog.org
2) Install a binary version
3) Install from the release files (pl-<version>.tar.gz)
If you use GIT, the generated documentation files are downloaded by the
./prepare script. This works both on Unix and Windows, where you can run
prepare using the shell that comes with the Windows port of msysgit.
Finally, you can build them
---------------------------
To do this:
* Get a Unix machine, preferably Linux as most requirements are
available by default.
* Install Prolog, at least with the pldoc package.
* Intall LaTeX, probably best the teTeX distribution
(http://www.tug.org/tetex/) that comes with many Linux systems.
* Install the plain-text conversion tools from pl/man/txt using
the README there.
* Build and install latex2html from packages/ltx2htm
If all that is installed correctly, it should be possible to generate
all documentation using the following from the toplevel:
% make doc
Alternatively, build the system docs from the Makefile in the man
directory and the documentation for packages in the package directory.
Each pachage with documentation has the make targets 'pdf' to create the
PDF docs and 'html' to create the HTML documentation.