summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordjp <[email protected]>2003-06-08 22:24:51 +0000
committerdjp <[email protected]>2003-06-08 22:24:51 +0000
commit18b80112cef7ebad875a1768a8adf23d8e8dc364 (patch)
treeff9d86420a5783b179860fc58ac864fd416c67c8
parentd49fd968963909f181423eae46c613189468fac3 (diff)
update docs
git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@7 232f8b59-042b-4e1e-8c03-345bb8c30851
-rw-r--r--doc/HowToBuild.html7
-rw-r--r--www/index.html97
2 files changed, 95 insertions, 9 deletions
diff --git a/doc/HowToBuild.html b/doc/HowToBuild.html
index 73a4a943e..33a2feafb 100644
--- a/doc/HowToBuild.html
+++ b/doc/HowToBuild.html
@@ -23,17 +23,16 @@ OpenGL binding from a fresh copy of the source distribution:
<LI><b>On Linux/Solaris:</b> Gnu Make is probably already installed. If it is not, you can obtain it from <a href="http://www.gnu.org/directory/devel/build/make.html">http://www.gnu.org/directory/devel/build/make.html</a>
<LI><b>On Win32:</b> You have two options. The first is to install the Cygwin environment, available from <a href="http://www.cygwin.com/">http://www.cygwin.com/</a>. The second (untested) option is to install the GnuWin32 tools, available from <a href="http://sourceforge.net/projects/gnuwin32/"</a>http://sourceforge.net/projects/gnuwin32/</a>.
</UL>
- <LI> <B>Build the source tree:</B> <br> You can do this by opening a command shell in the "make" directory of the source tree and typing "make PLATFORM COMPILER_OPTIONS CG_OPTIONS". PLATFORM, COMPILER_OPTIONS and CG_OPTIONS are as follows:
+ <LI> <B>Build the source tree:</B> <br> You can do this by opening a command shell in the "make" directory of the source tree and typing "make PLATFORM COMPILER_OPTIONS". PLATFORM, COMPILER_OPTIONS are as follows:
<UL>
<LI><b>PLATFORM</b> This must be one of "win32", "x11", or "macosx". "win32" will build the code for 32-bit Microsoft Windows operating systems, "x11" will build for Linux or Sun Solaris, and "macosx" will build for Apple MacOS X.
- <LI><b>COMPILER_OPTIONS</b> This is currently only needed when "win32" is specified. COMPILER_OPTIONS must be one of "VC6=1" or "VC7=1"; choosing the former will invoke the Microsoft Visual C++ 6.0 compiler, and the latter option will invoke the Microsoft Visual C++ 7 (Visual Studio .NET) compiler. These are the two compilers currently supported by Jogl on Win32.
- <LI><b>CG_OPTIONS</b> A value of "CG=1" will generate an experimental binding for the Cg language runtime by NVidia Corporation. As of this writing the Cg binding was only supported on the Windows platform.
+ <LI><b>COMPILER_OPTIONS</b> This is currently only needed when "win32" is specified. COMPILER_OPTIONS must be one of "VC6=1" or "VC7=1"; choosing the former will invoke the Microsoft Visual C++ 6.0 compiler, and the latter option will invoke the Microsoft Visual C++ 7 (Visual Studio .NET) compiler. These are the two compilers currently supported by Jogl on Win32.
</UL>
<LI> <B>Add Jogl to your CLASSPATH:</B> <br> To be able to use Jogl, you must add the build process Java bytecode output directory (<source tree root>/build/classes) to your CLASSPATH environment variable.
<LI> <B>Add Jogl to your PATH:</B> <br> To be able to use Jogl, you must also add the build process JNI code library directory (<source tree root>/build/obj) to your PATH.
<LI> <B>Test if everything's working:</B> <br> To test if everything went well, you should build the "Gears.java" demo in the "<source tree root>/demos/gears" directory. Run "javac Gears.java" and then "java Gears"; you should see some spinning 3D gears appear in a window.
- <LI> <B>Build Javadoc:</B> <br> "make doc" will produce the end-user documentation for Jogl along with some auxiliary utility packages. "make devdoc" will produce the developers' documentation, including that for the GlueGen tool. Appending "CG=1" to either of these commands will cause the javadoc for the Cg binding to be generated.
+ <LI> <B>Build Javadoc:</B> <br> "make doc" will produce the end-user documentation for Jogl along with some auxiliary utility packages. "make devdoc" will produce the developers' documentation, including that for the GlueGen tool.
</OL>
Note that there are a lot of warnings produced by ANTLR about the
diff --git a/www/index.html b/www/index.html
index a116ed4d6..41d5d4753 100644
--- a/www/index.html
+++ b/www/index.html
@@ -1,5 +1,92 @@
-<html>
- <body>
- This is the default project content.
- </body>
-</html>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML><HEAD>
+<META content="text/html; charset=windows-1252" http-equiv=Content-Type>
+<META content="MSHTML 5.00.2920.0" name=GENERATOR></HEAD>
+<BODY>
+<DIV align=center><FONT color=#990000 size=+2>Welcome to the JOGL API
+Project! </FONT></DIV>
+<TABLE border=0 cellPadding=0 cellSpacing=1 width="100%">
+ <TBODY>
+ <TR>
+ <TD vAlign=top width="66%">
+ <TABLE border=0 cellPadding=5 cellSpacing=1 height=358 width="100%">
+ <TBODY>
+ <TR>
+ <TD vAlign=top>
+ <TABLE bgColor=#990000 border=0 cellPadding=5 cellSpacing=1
+ width="100%">
+ <TBODY>
+ <TR>
+ <TD bgColor=#990000 vAlign=top width=589>
+ <DIV align=left><FONT
+ color=#ffffff><STRONG>Overview</STRONG></FONT></DIV></TD></TR>
+ <TR>
+ <TD bgColor=#ffffff vAlign=top>
+ <DIV align=justify>
+ <P>The JOGL Project hosts a reference implementation of the Java
+ bindings for OpenGL API, and is designed to provide hardware-supported
+ 3D graphics for applications written in Java. It is part of a
+ suite of open-source technologies initiated by the Game
+ Technology Group at Sun Microsystems.</P>
+ </DIV></TD></TR></TBODY></TABLE></TD></TR>
+ <TR>
+ <TD>
+ <TABLE bgColor=#990000 border=0 cellPadding=5 cellSpacing=1
+ width="100%">
+ <TBODY>
+ <TR>
+ <TD bgColor=#990000 width=589>
+ <DIV align=left><FONT color=#ffffff><STRONG>Project
+ Status</STRONG></FONT></DIV></TD></TR>
+ <TR>
+ <TD bgColor=#ffffff>
+ <DIV align=justify>The intial implementation of the Jogl
+ API is available for download from <A
+ href="http://jogl.dev.java.net/source/browse/jogl/">CVS</A>.
+ </DIV></TD></TR></TBODY></TABLE></TD></TR>
+ <TR>
+ <TD>
+ <TABLE bgColor=#990000 border=0 cellPadding=5 cellSpacing=1
+ width="100%">
+ <TBODY>
+ <TR>
+ <TD bgColor=#990000 width=589>
+ <DIV align=left><FONT color=#ffffff><STRONG>Getting Started
+ </STRONG></FONT></DIV></TD></TR>
+ <TR>
+ <TD bgColor=#ffffff vAlign=top>
+ <P>This project has been built in the following
+ environment:</P>
+ <UL>
+ <LI>Win32 (Win 2000 in the case of our machine)
+ <LI>Sun J2SDK 1.4.2 (available at <A
+ href="http://java.sun.com/" target=_blank>java.sun.com</A>)
+ <LI>MinGW 2.0.0 plus the following updates: (all available
+ at <A href="http://www.mingw.org/"
+ target=_blank>http://www.mingw.org/</A>)
+ <UL>
+ <LI>binutils 2.13.90
+ <LI>w32api-2.2
+ <LI>mingw-runtime-2.4
+ </UL>
+ </A></P></LI></UL></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
+ <P>&nbsp;</P></TD>
+ <TD vAlign=top>
+ <TABLE border=0 cellPadding=5 cellSpacing=1 width="100%">
+ <TBODY>
+ <TR>
+ <TD>
+ <TABLE bgColor=#990000 border=0 cellPadding=5 cellSpacing=1
+ width="100%">
+ <TBODY>
+ <TR>
+ <TD bgColor=#990000 vAlign=top>
+ <DIV align=left><FONT color=#ffffff><STRONG>Useful
+ Links</STRONG></FONT></DIV></TD></TR>
+ <TR>
+ <TD valign="top" bgcolor="#FFFFFF"><UL>
+ <LI><A href="http://www.opengl.org" target="_blank">OpenGL</A>
+ Home</LI>
+ </TR></TBODY></TABLE></TD></TR>
+ <TR>
+ <TD>&nbsp;</TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE></BODY></HTML>