summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README-build.html130
1 files changed, 80 insertions, 50 deletions
diff --git a/README-build.html b/README-build.html
index 5a2c3e8..fc18a92 100644
--- a/README-build.html
+++ b/README-build.html
@@ -1,5 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-
+<html>
+<head>
<!--
/*
* $RCSfile$
@@ -45,26 +46,31 @@
* $State$
*/
-->
-
-<html>
-<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
- <title>README-build</title>
+ <title>README-build: build instructions for the j3d-examples project</title>
</head>
<body>
-<span style="font-weight: bold; text-decoration: underline;">Building
-the Java 3D examples&nbsp; programs<br>
-<br>
-</span>To build the Java 3D examples programs, you must first download
-the j3d-examples
-CVS repository:<span
- style="font-weight: bold; text-decoration: underline;"><br>
-<br>
-System Requirements<br>
-<br>
-</span>Any operating environment that supports J2SE and Java 3D should
+<h3><span style="text-decoration: underline;">Building
+the Java&nbsp;3D Example Programs</span></h3>
+<p>To
+build the Java&nbsp;3D example programs, you must first checkout the <a
+ href="http://j3d-examples.dev.java.net/">j3d-examples</a>
+CVS
+repository on java.net. For example, run
+the cvs checkout command as follows:<br>
+</p>
+<ul>
+ <code>cd &lt;cvs-root-dir&gt;</code><br>
+ <code>cvs checkout j3d-examples</code>
+</ul>
+<p>
+</p>
+<h3><span style="text-decoration: underline;">System Requirements</span>
+</h3>
+<p>Any operating environment that supports J2SE and Java&nbsp;3D should
work.We have built j3d-examples on the following operating environments:<br>
+</p>
<ul>
<li>Solaris: Sparc (Ultra60 or better) running Solaris 9</li>
<li>Linux: i386/i586 running SuSE 9 or RedHat 9.0</li>
@@ -72,44 +78,68 @@ work.We have built j3d-examples on the following operating environments:<br>
2000 should work, but is untested)<br>
</li>
</ul>
-The following software must be installed:<br>
+<p>The following software must be installed:</p>
<ul>
- <li><a href="http://java.sun.com/j2se">JDK 1.4.2&nbsp;</a> <br>
- </li>
- <li><a href="http://jakarta.apache.org/ant">Apache Ant 1.6.1&nbsp;</a>
- <br>
- </li>
- <li><a href="http://java.sun.com/products/java-media/3D/">Java 3D
-1.3.1</a> or later.<br>
- </li>
+ <li><a href="http://java.sun.com/j2se">JDK 1.4.2</a> </li>
+ <li><a href="http://jakarta.apache.org/ant">Apache Ant 1.6.1</a> </li>
+ <li><a href="http://java.sun.com/products/java-media/3D/">Java&nbsp;3D
+1.3.1</a> or later. </li>
</ul>
-<span style="font-weight: bold; text-decoration: underline;">Building
-j3d-examples<br>
-<br>
-</span> Before you start building, please check that your PATH must
+<h3><span style="text-decoration: underline;">Building
+j3d-examples</span><span
+ style="font-weight: bold; text-decoration: underline;"></span><br>
+</h3>
+<p>Before you start building, please check that your PATH must
include the
-following directories:<br>
-&nbsp;&nbsp;&nbsp; .&nbsp;&nbsp;&nbsp; &lt;ant-root-dir&gt;/bin<br>
-&nbsp;&nbsp;&nbsp; .&nbsp;&nbsp;&nbsp; &lt;jdk-root_dir&gt;/bin<br>
-<br>
-NOTE that Java 3D must be installed into the JDK that you have in your
-path <span style="font-weight: bold;">OR</span> you must put the Java
-3D &amp; vecmath jar files in your CLASSPATH and the Java 3D libraries
-in your LD_LIBRARY_PATH.<br>
-<br>
-To build all examples:<br>
-<br>
-&nbsp;&nbsp;&nbsp; cd &lt;java3d-root&gt;/j3d-examples<br>
-&nbsp;&nbsp;&nbsp; ant<br>
-<br>
-This will build all example programs, each one being placed in the
-corresponding src/&lt;ExampleProgram&gt; directory.&nbsp; You may run
+following directories:</p>
+<ul>
+ <li>&lt;ant-root-dir&gt;/bin</li>
+ <li>&lt;jdk-root_dir&gt;/bin</li>
+</ul>
+<p>NOTE that Java&nbsp;3D must be installed into the JDK that you have in
+your path <span style="font-weight: bold;">OR</span> you must put the
+Java&nbsp;3D and vecmath jar files (j3dcore.jar, j3dutils.jar and
+vecmath.jar) in your CLASSPATH and the directory containing the
+Java&nbsp;3D libraries in your LD_LIBRARY_PATH (Solaris or Linus) or
+PATH (Windows).<br>
+</p>
+<p>To build all examples:</p>
+<ul>
+ <code>cd &lt;cvs-root-dir&gt;/j3d-examples</code><br>
+ <code>ant</code>
+</ul>
+<p>
+</p>
+<p>This will build all example programs, each one being placed in the
+corresponding <code>src/&lt;ExampleProgram&gt;</code> directory.
+You may run
ant from a subdirectory in order to just build that program. For
-example, to<br>
-build the HelloUniverse program:<br>
-<br>
-&nbsp;&nbsp;&nbsp; cd &lt;java3d-root&gt;/j3d-examples/src/HelloUniverse<br>
-&nbsp;&nbsp;&nbsp; ant<br>
+example, to build the HelloUniverse program:<br>
+</p>
+<ul>
+ <code>cd &lt;cvs-root-dir&gt;/j3d-examples/src/HelloUniverse</code><br>
+ <code>ant</code>
+</ul>
+<p>
+</p>
+<h3><span style="text-decoration: underline;">Running j3d-examples</span></h3>
+<p>To run an example program, cd to the desired directory and execute
+java from there. You must ensure that CLASSPATH is either not set, or
+contains "." in its list of directories. For example, to run the
+HelloUniverse program:<br>
+</p>
+<ul>
+ <code>cd &lt;cvs-root-dir&gt;/j3d-examples/src/HelloUniverse</code><br>
+ <code>java HelloUniverse<br>
+ </code>
+</ul>
+<p>
+</p>
+<p>You may also point your Java-enabled web browser at the
+<code>src/index.html</code> page and run Java&nbsp;3D example programs
+from within your browser. Java&nbsp;3D must be installed into the JDK
+in order to run Java&nbsp;3D programs from within a browser.<br>
<br>
+</p>
</body>
</html>