[Gzz-commits] gzz README

[Tuukka Hastrup]

CVSROOT:        /cvsroot/gzz
Module name:    gzz
Changes by:     Tuukka Hastrup <address@hidden> 02/08/28 11:14:05

Modified files:
        .              : README 

Log message:
        Updated and included info on releases

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/README.diff?tr1=1.25&tr2=1.26&r1=text&r2=text

Patches:
Index: gzz/README
diff -c gzz/README:1.25 gzz/README:1.26
*** gzz/README:1.25     Mon Aug 26 13:09:39 2002
--- gzz/README  Wed Aug 28 11:14:05 2002
***************
*** 66,132 ****
  
      http://www.freesoftware.fsf.org/gzz/
  
  
- Compiling gzz
- =================
  
! Here we have basic instructions for compiling and running gzz
! on Debian GNU/Linux systems.
  
! Prepare system:
!     # # Basic Gzz depends on 
!     # apt-get install cvs j2sdk1.3 perl python2.2 rsync 
  
!     $ cvs -d:pserver:address@hidden:/cvsroot/gzz co gzz
!     $ cvs -d:pserver:address@hidden:/cvsroot/gzz co depends
  
  
!     $ mkdir Z
!     $ mkdir Z-private
  
- Edit Z/properties to contain:
  
!     ---
!     dirstorer.maxlen=240
!     simplemediaserver.poolname=gzz-base
!     ---
  
! (See README-MS for more information about the Mediaserver system and its data 
! pools.)
  
! Compile:
      $ cd gzz
      $ make compile
!     $ make httpsync # Not necessary for current clients
!     $ make test     # Some tests may fail without synced Mediaserver dir
  
  Documentation:
  
-     # apt-get install netpbm tetex-bin doc++ 
      $ make doc
  
  (recompile after this as 'make doc' has to remove some compiled files
  
! Run the clients:
! $ make run
! 
!     # # OpenGL accelerated Gzz depends on
!     # apt-get install libfreetype6-dev g++-3.0 libgdk-pixbuf-dev glutg3-dev 
libboost-dev
  
  For OpenGL accelerated applications, you'll need the support for your 3D 
card, 
! and the card better be a good one too.
  
! Compile (deploys C++ code through JNI):
  
      $ JAVAHOME=/usr/lib/j2sdk1.3 make glgzz
  
! Run the clients:
  
      $ make rungl
  
!     $ make runglpp     # Not used at the moment
! 
! also, some demos:
  
      $ make runfillets
  
--- 66,182 ----
  
      http://www.freesoftware.fsf.org/gzz/
  
+ We release JAR files that should run on any computer with a suitable Java 
+ Runtime installed. The source code is available in tar.gz archives or
+ can be checked out using CVS.
  
  
! Launching gzz from JAR
! ======================
  
! The JAR file in the current directory, you can use the following commands 
! to start gzz: (in the current version, no data can be saved)
  
! $ java -jar gzz-version.jar -t
  
+ or
  
! $ java -cp gzz-version.jar gzz.control.Main -t
  
  
! Compiling gzz from released source
! ==================================
  
! The source releases contain precompiled contents of doc/ directory and
! preprocessed versions of Java source files that need preprocessing. The 
! idea is that all you need for compiling is a suitable Java Development 
! Kit. If you don't have GNU Make available, you can still generate the 
! Java class files with a standard java compiler (javac) and run the normal
! gzz client with "java gzz.control.Main -t".
  
! The native code used for the OpenGL client can be built and works only
! on Linux at the moment. 
! 
! Otherwise the instructions are the same as for the CVS versions. Please 
! notice that if you use target 'clean' in the Makefile, the generated 
! files are removed and to rebuild them you'll need the same programs 
! installed as the CVS version.
! 
! 
! Compiling gzz from source in CVS
! ================================
! 
! You can get current source from anonymous CVS repository:
!     $ cvs -d:pserver:address@hidden:/cvsroot/gzz co gzz
!     $ cvs -d:pserver:address@hidden:/cvsroot/gzz co depends
      $ cd gzz
+ 
+ The following targets are included in the Makefile:
+ all (default): build normal client and run tests
+ compile:       build normal client
+ test:          run tests
+ run:           run normal client (you can't save data at the moment)
+ glgzz:         build OpenGL client
+ rungl:         run OpenGL client
+ doc:           build documentation in doc/
+ clean:         remove all generated files
+ 
+ To compile, test and run the normal client, you'll need:
+ Software name                                Corresponding Debian package
+ -------------------------------------------------------------------------
+ GNU Make                                     make
+ Java Development Kit                         j2sdk1.3
+ Perl                                         perl
+ Python 2.2                                   python2.2
+ 
+ To generate documentation, you'll need:
+ Makefile target | Software name              Corresponding Debian package
+ ----------------+--------------------------------------------------------
+ javadoc         | Java Development Kit       j2sdk1.3
+ ----------------+--------------------------------------------------------
+ documl          | Python                     python
+                 | Netpbm                     netpbm
+                 | Metapost                   tetex-bin
+ ----------------+--------------------------------------------------------
+ docxx           | DOC++                      doc++
+ ----------------+--------------------------------------------------------
+ 
+ Compile:
      $ make compile
!     $ make test
  
  Documentation:
  
      $ make doc
  
  (recompile after this as 'make doc' has to remove some compiled files
  
! Run the client:
!     $ make run
  
  For OpenGL accelerated applications, you'll need the support for your 3D 
card, 
! and the card better be a good one too. You'll need following:
! Software name                                Corresponding Debian package
! -------------------------------------------------------------------------
! GNU C++ compiler version 3.1                 g++-3.1
! GNU stdc++ library                           libstdc++3-dev
! Boost.org C++ library                        libboost-dev
! FreeType 2 font engine                       libfreetype6-dev
! GdkPixBuf library                            libgdk-pixbuf-dev
! Glib library                                 libglib1.2-dev
! GTK library                                  libgtk1.2-dev
! Mesa library                                 mesag-dev
! GLUT library                                 glutg3-dev
  
! Compile the OpenGL client (deploys C++ code through JNI):
  
      $ JAVAHOME=/usr/lib/j2sdk1.3 make glgzz
  
! Run the OpenGL client:
  
      $ make rungl
  
! Run some OpenGL demos:
  
      $ make runfillets