-
Notifications
You must be signed in to change notification settings - Fork 2
/
INSTALL.html
84 lines (80 loc) · 2.82 KB
/
INSTALL.html
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<html>
<head><title>GoGui Installation Notes</title></head>
<body>
<p>
<h1>GoGui Installation Notes</h1>
<h2>Basics</h2>
<p>
GoGui requires at least Java version 5. The recommended Java runtime
environment is Sun's Java SE 6. GoGui will also work in OpenJDK, but at
the time of this writing there were still minor rendering issues if GoGui is
used with OpenJDK (e.g. the stones on the board are not completely round;
the last tested version was OpenJDK 14.0-b16).
</p>
<p>
GoGui comes with precompiled Java jar files for GoGui and the GTP tools
in the lib directory. GoGui does not necessarily need to be installed on the
system, it can be run from the directory where the distribution file was
extracted to.
</p>
<p>
For Unix systems there are launcher scripts in the bin directory.
The launcher scripts respect the environment variable GOGUI_JAVA_HOME, if
defined, and look for the jar files relative to the bin directory.
</p>
<h2>Installation on Linux</h2>
<p>
For Linux, there is an installation script <tt>install.sh</tt>, which installs
GoGui into the system directories and integrates it into the desktop
environment. This script needs to be run as root and requires the option
<tt>-j</tt> with the location of a Java 5 compatible virtual machine.
</p>
<p>
On Ubuntu 9.10, it is recommended to install the package sun-java6-jre
in the Synaptic package manager, and then install GoGui by running the command:
<blockquote>
<tt>sudo ./install.sh -j /usr/lib/jvm/java-6-sun</tt>
</blockquote>
On Ubuntu 10.4, the package sun-java6-jre has been moved to the partner
repository. You first have to add the partner repository by running the
command:
<blockquote>
<tt>sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner"</tt>
</blockquote>
</p>
<h2>Installation on Windows</h2>
<p>
Currently, no installation program for Windows exists. GoGui can still be
run on Windows, if Java is installed, by clicking on the file
<tt>gogui.jar</tt> in the <tt>lib</tt> directory.
</p>
<h2>Installation on Mac OS</h2>
<p>
A Mac application bundle can be created by compiling GoGui from the sources
(see below) and running
<blockquote>
<tt>ant gogui.app</tt>.
</blockquote>
</p>
<h2>Compiling from the Sources</h2>
<ul>
<li>
Compiling GoGui from the sources needs the
<a href="http://ant.apache.org">Ant build system</a>.
</li>
<li>
The HTML documentation is generated using Docbook.
To re-generate the HTML files after changes in the XML files,
the XSL transformer <a href="http://xmlsoft.org/XSLT">xsltproc</a> has to be
installed.
The built in ant target <tt>Style</tt> is no longer used, because it has
problems with newer versions of Docbook XSL and also replaces some HTML
entities in a way that the Java JEditorPane does not render correctly.
</li>
<li>
If all requirements are met, simply type <tt>ant</tt> in the main directory of
GoGui.
</li>
</ul>
</body>
</html>