Skip to content
Browse files

Replacing txt files by html

  • Loading branch information...
1 parent cfbc9e6 commit 2edd79d6840a27f29a9a74bb933e9219d3d2b847 Markus Enzenberger committed Aug 15, 2010
View
19 CONTRIBUTE
@@ -1,19 +0,0 @@
-Patches for fixing bugs in GoGui are always welcome. Patches that add
-a significant amount of functionality should first be discussed with the
-author.
-
-The copyright holder of GoGui is Markus Enzenberger. By sending a patch, you
-implicitely transfer the copyright on the patch to him. In countries where a
-copyright transfer is not possible, you give him unrestricted permission to
-use your code in any way, including changing the license of future
-versions of GoGui or offering it under multiple licenses.
-
-Larger patches should:
-
-- be written using best coding practices
-- be well tested (if possible with unit tests in test/sunit/src)
-- respect the existing formatting and coding style of the existing code
-- not contain tab-characters
-- be submitted as a diff (see http://en.wikipedia.org/wiki/Diff) to the source
- in the main branch of the SVN repository
-
View
28 COPYING → COPYING.html
@@ -1,25 +1,35 @@
-GoGui License
-=============
-
-Copyright (C) 2001-2010 Markus Enzenberger (enz@users.sourceforge.net)
-
+<html>
+<head><title>GoGui License</title></head>
+<body>
+<h1>GoGui License</h1>
+<p>
+Copyright &copy; 2001-2010 Markus Enzenberger (enz@users.sourceforge.net)
+</p>
+<p>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
-
+</p>
+<p>
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
-
+</p>
+<p>
A full copy of the GNU General Public License is included in
the GoGui documentation.
-
+</p>
+<p>
NOTE! This copyright does *not* cover Go engines that use GoGui
services by the GTP protocol - this is merely considered normal use
of GoGui, and does *not* fall under the heading of "derived work".
-
+</p>
+<p>
The files in the directory "external" are from third parties. They are not
part of GoGui and have different licenses and copyright holders. They are
included in the GoGui distribution only for convenience.
+</p>
+</body>
+</html>
View
60 INSTALL
@@ -1,60 +0,0 @@
-Basics
-======
-
-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).
-
-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.
-
-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.
-
-Installation on Linux
-=====================
-
-For Linux, there is an installation script install.sh, 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 -j
-with the location of a Java 5 compatible virtual machine.
-
-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:
-
- sudo ./install.sh -j /usr/lib/jvm/java-6-sun
-
-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:
-
- sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner"
-
-
-Installation on Mac OS
-======================
-
-A Mac application bundle can be created by compiling GoGui from the sources
-(see below) and running "ant gogui.app".
-
-Compiling from the Sources
-==========================
-
-* Compiling GoGui from the sources needs the Ant build system
- (http://ant.apache.org).
-
-* The HTML documentation is generated using Docbook.
- To re-generate the HTML files after changes in the XML files,
- the XSL transformer "xsltproc" (http://xmlsoft.org/XSLT) has to be
- installed.
- The built in ant target "Style" 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.
-
-* If all requirements are met, simply type "ant" in the main directory
- of GoGui.
View
77 INSTALL.html
@@ -0,0 +1,77 @@
+<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 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>
View
6 README
@@ -1,6 +0,0 @@
-GoGui is a graphical interface to programs that play the game of Go
-and use GTP (Go Text Protocol).
-
-See INSTALL for installation notes.
-See COPYING for license information.
-See doc/manual/html/index.html for documentation and release notes.
View
15 README.html
@@ -0,0 +1,15 @@
+<html>
+<head><title>GoGui README</title></head>
+<body>
+<p>
+GoGui is a graphical interface to programs that play the game of Go
+and use GTP (Go Text Protocol).
+</p>
+<p>
+See <a href="INSTALL.html">INSTALL.html</a> for installation notes.<br />
+See <a href="COPYING.html">COPYING.html</a> for license information.<br />
+See <a href="doc/manual/html/index.html">doc/manual/html/index.html</a> for
+documentation and release notes.<br />
+</p>
+</body>
+</html>
View
15 build.xml
@@ -139,10 +139,9 @@ Comment out the following exec tag for releases.
<target name="dist" depends="all,check">
<zip destfile="gogui-${version}.zip">
<zipfileset prefix="gogui-${version}" dir="." includes="
- README
- CONTRIBUTE
- COPYING
- INSTALL
+ README.html
+ COPYING.html
+ INSTALL.html
build.xml
config/go.dtd
config/gogui-gogui.desktop
@@ -152,7 +151,7 @@ Comment out the following exec tag for releases.
config/gogui-C.omf.in
config/gogui.schemas
config/gogui-mime.xml
- doc/README
+ doc/README.html
doc/manual/html/*.html
doc/manual/html/*.png
doc/manual/man/*.1
@@ -161,7 +160,7 @@ Comment out the following exec tag for releases.
doc/manual/xml/*.xsl
doc/doxygen/Doxyfile
doc/doxygen/footer.html
- doc/doxygen/README
+ doc/doxygen/README.html
${docbook.path}.zip
${quaqua.nestedzipfile}
lib/*.jar
@@ -172,9 +171,9 @@ Comment out the following exec tag for releases.
mac/src/net/sf/gogui/specialmac/RegisterSpecialMacHandler.java
mac/src/net/sf/gogui/specialmac/RegisterSpecialMacHandler.class
mac/src/net/sf/gogui/specialmac/Listener.class
- sgf/openings/9x9/README
+ sgf/openings/9x9/README.html
sgf/openings/9x9/*.sgf
- sgf/openings/19x19/README
+ sgf/openings/19x19/README.html
sgf/openings/19x19/*.sgf
src/net/sf/gogui/images/*.png
src/net/sf/gogui/images/*.svg
View
6 doc/README → doc/README.html
@@ -1,3 +1,6 @@
+<html>
+<body>
+<pre>
doxygen/
Complete source code documentation generated by Doxygen
@@ -7,3 +10,6 @@
javadoc/
Source code documentation of the public members and classes generated
by Javadoc
+</pre>
+</body>
+</html>
View
6 doc/doxygen/README → doc/doxygen/README.html
@@ -1,3 +1,6 @@
+<html>
+<body>
+<pre>
Source code documentation generation using Doxygen.
Produces better source code documentation than Javadoc.
@@ -6,3 +9,6 @@
Dot tool from Graphviz http://www.graphviz.org
Run doxygen in this directory to generate the documentation.
+</pre>
+</body>
+</html>
View
6 sgf/openings/19x19/README → sgf/openings/19x19/README.html
@@ -1,4 +1,10 @@
+<html>
+<body>
+<pre>
19x19 opening positions which can be used for twogtp with the -openings
option.
All positions are taken from games with players of rank greater or equal
one dan.
+</pre>
+</body>
+</html>
View
6 sgf/openings/9x9/README → sgf/openings/9x9/README.html
@@ -1,3 +1,6 @@
+<html>
+<body>
+<pre>
9x9 opening positions which can be used for twogtp with the -openings
option.
@@ -7,3 +10,6 @@
They should be roughly balanced, but it is still recommended to play each of
them twice with colors exchanged and average over the results
(twogtp -alternate option).
+</pre>
+</body>
+</html>

0 comments on commit 2edd79d

Please sign in to comment.
Something went wrong with that request. Please try again.