[Jrman-commit] drafts/jrMan README.TXT,1.7,1.8

[<ma...@us...>]

Update of /cvsroot/jrman/drafts/jrMan
In directory sc8-pr-cvs1:/tmp/cvs-serv25444/jrMan

Modified Files:
	README.TXT 
Log Message:
More preparations for release 0.2

Index: README.TXT
===================================================================
RCS file: /cvsroot/jrman/drafts/jrMan/README.TXT,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** README.TXT	30 May 2003 02:11:18 -0000	1.7
--- README.TXT	30 Sep 2003 00:35:26 -0000	1.8
***************
*** 1,183 ****
! What is jrMan? (Java Renderman)
! --------------
! jrMan is an open source implementation of the REYES (Render Everything You Ever
! Saw) algorithm used by Pixar's PhotoRealistic Renderman to render images.
! 
! Although PhotoRealistic Renderman is used to generate most CGI (Computer
! Generated Images) in motion pictures, textbooks on computer graphics do not
! explain how its REYES algorithm works (actually many books do not even mention
! it!). The intention of the jrMan project is to  provide a full implementation
! in Java fo the Renderman standard using the REYES algorithm, so it can be used
! by computer graphics teachers and students.
! 
! 
! Setup:
! ------
! To install jrMan you must first download and install the JDK 1.4.1 (or above)
! and the Java3D API (jrMan uses the javax.vecmath package from Java3D). You can
! find both of them at:  http://java.sun.com
! 
! Once Java is installed in your system you need to download the jrman-0_1.zip or jrman-0_1.tar.gz
! file an unzip (tar xfz) it. This will create a "jrman-0_1" directory with all the files you
! need.
! 
! Then you must setup a couple of environment variables. If you are using Windows
! you might need to type something like this at the command prompt:
! 
! set PATH=%PATH%;C:\jrman-0_1\bin
! set JRMAN_HOME=C:\jrman-0_1
! 
! (assuming you unpacked the jrMan distribution in C:\)
! 
! If you are using Linux or Unix you might need to type something like:
! 
! export PATH=$PATH:/usr/local/jrman-0_1/bin
! export JRMAN_HOME=/usr/local/jrman-0_1
! 
! (assuming you unzipped the jrMan distribution in /usr/local)
! 
! 
! Running jrMan:
! --------------
! To render the scene described in a file named "scene.rib" you just type at the
! command prompt:
! 
! jrMan scene.rib
! 
! The "model" subdirectory of the jrMan distribution contains some sample scenes
! you can use to try jrMan:
! 
! uTeapot.rib
! aphrodite.rib
! bike.rib
! elephant.rib
! ManySpheres.rib
! DinningRoom.rib
! vehicles.rib
! capsules.rib
! 
! (all the other .rib files in the model directory are data files used by the
! above scenes).
! 
! 
! Renderman features implemented in jrMan 0.1:
! --------------------------------------------
! * Primitives:
!         Sphere
!         Torus
!         Cone
!         Disk
!         Cylinder
!         Paraboloid
!         Points
!         Patch "bilinear"
!         Patch "bicubic" (only Bezier)
!         ObjectInstance
! 
! * Surface shaders:
!         constant
!         matte
!         plastic
!         metal
!         fakedlight (used by jrMan when there isn't any surface shader
!                     declared for the primitive)
!         glow (from the Renderman Companion book)
!         randomcolors (used for capsules.rib)
! 
! * Light shaders:
!         ambientlight
!         distantlight
!         pointlight
!         spotlight
! 
! * Volume shaders:
!         fog
!         depthcue
! 
! * Displacement shaders:
!         bumptest (to test the implementation of displacements in jrMan)
! 
! 
! Renderman features not yet implemented in jrMan 0.1:
! ----------------------------------------------------
! * Shading language compiler
! * Motion blur
! * Depth of field
! * Level of detail
! * CSG
! * Shadows
! * Texture mapping
! * Nurbs and trim curves
! * Subdivision surfaces
! * Curves
! * Polygons
! * Hyperboloid
! * Generate image to file
! * Pixel filters (other than "box")
! * Bicubic patches != "bezier"
! * PatchMesh
! 
! 
! Comparing jrMan 0.1 to other Renderman renderers:
! -------------------------------------------------
! To make make an apples to apples comparison, make sure your RIB file has
! these two lines:
! 
! Display "sceneName" "framebuffer" "rgb"
! PixelFilter "box" 1 1
! 
! This is because jrMan 0.1 only displays images on screen and it only has
! a box pixel filter. These two lines will make sure the other renderer is
! doing the same thing.
! 
! We also provided in the "model" directory the shading language source code for:
! glow, randomcolors and bumptest.
! 
! 
! Creating RIB files for jrMan:
! -----------------------------
! We have found the following tools useful in creating RIB files:
! 
! JPatch
! http://jpatch.sourceforge.net
! 
! Hamapatch
! http://www.geocities.com/hamapatch/program/index.html
! 
! There is also another one which should work but we haven't it tried yet:
! 
! sPatch
! http://www.geocities.com/getspatch/
! 
! Note: To generate better looking images we recomend you edit the RIB files
! generated by these tools and add these two lines near the beginning (before
! WorldBegin):
! 
! PixelSamples 4 4
! Exposure 1 2.2
! 
! 
! Finding out more about Renderman:
! ---------------------------------
! * Books:
!         The Renderman Companion
!         http://www.amazon.com/exec/obidos/tg/detail/-/0201508680/qid=1054250992/sr=1-3/ref=sr_1_3/002-1269619-5837619?v=glance&s=books
! 
!         Advanced Renderman
!         http://www.amazon.com/exec/obidos/tg/detail/-/1558606181/qid=1054251110/sr=1-1/ref=sr_1_1/002-1269619-5837619?v=glance&s=books
! 
!         The Renderman 3.2 Specification
!         https://renderman.pixar.com/
! 
! * Sites:
!         Renderman Repository
!         http://www.renderman.org/RMR/
! 
!         Renderman FAQ
!         http://www.faqs.org/faqs/graphics/renderman-faq/
!         
!         comp.graphics.rendering.renderman
!         http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&oe=UTF-8&group=comp.graphics.rendering.renderman
! 
! 
  Renderman and PhotoRealistic Renderman are trademarks of Pixar.
--- 1,189 ----
! What is jrMan? (Java Renderman)
! --------------
! jrMan is an open source implementation of the REYES (Render Everything You Ever
! Saw) algorithm used by Pixar's PhotoRealistic Renderman to render images.
! 
! Although PhotoRealistic Renderman is used to generate most CGI (Computer
! Generated Images) in motion pictures, textbooks on computer graphics do not
! explain how its REYES algorithm works (actually many books do not even mention
! it!). The intention of the jrMan project is to  provide a full implementation
! in Java fo the Renderman standard using the REYES algorithm, so it can be used
! by computer graphics teachers and students.
! 
! 
! Setup:
! ------
! To install jrMan you must first download and install the JDK 1.4.1 (or above)
! and the Java3D API (jrMan uses the javax.vecmath package from Java3D). You can
! find both of them at:  http://java.sun.com
! 
! Once Java is installed in your system you need to download the jrman-0_2.zip or
! jrman-0_2.tar.gz file an unzip (tar xfz) it. This will create a "jrman-0_2" directory
! with all the files you need.
! 
! Then you must setup a couple of environment variables. If you are using Windows
! you might need to type something like this at the command prompt:
! 
! set PATH=%PATH%;C:\jrman-0_2\bin
! set JRMAN_HOME=C:\jrman-0_2
! 
! (assuming you unpacked the jrMan distribution in C:\)
! 
! If you are using Linux or Unix you might need to type something like:
! 
! export PATH=$PATH:/usr/local/jrman-0_2/bin
! export JRMAN_HOME=/usr/local/jrman-0_2
! 
! (assuming you unzipped the jrMan distribution in /usr/local)
! 
! 
! Running jrMan:
! --------------
! To render the scene described in a file named "scene.rib" you just type at the
! command prompt:
! 
! jrMan scene.rib
! 
! The "model" subdirectory of the jrMan distribution contains some sample scenes
! you can use to try jrMan:
! 
! uTeapot.rib
! aphrodite.rib
! bike.rib
! elephant.rib
! ManySpheres.rib
! DinningRoom.rib
! vehicles.rib
! capsules.rib
! shadowTest.rib
! 
! (all the other .rib files in the model directory are data files used by the
! above scenes).
! 
! Note: shadowTest.rib might take a long time to render because all the parameters are set
! for a very high quality rendering. If you want it to render faster you might reduce the
! values for PixelSamples and "samples", and use a larger value for the ShadingRate.
! 
! 
! Renderman features implemented in jrMan 0.2:
! --------------------------------------------
! * Shadows
! 
! * Texture mapping
! 
! * Primitives:
!         Sphere
!         Torus
!         Cone
!         Disk
!         Cylinder
!         Paraboloid
!         Hyperboloid
!         Points
!         Patch "bilinear"
!         Patch "bicubic" (only Bezier)
!         Polygon
!         PointsPolygon
!         ObjectInstance
! 
! * Surface shaders:
!         constant
!         matte
!         plastic
!         paintedplastic
!         reflectivepaintedplastic
!         metal
!         fakedlight (used by jrMan when there isn't any surface shader
!                     declared for the primitive)
!         glow (from the Renderman Companion book)
!         randomcolors (used for capsules.rib)
! 
! * Light shaders:
!         ambientlight
!         distantlight
!         pointlight
!         spotlight
!         shadowspotlight
!         shadowdistantlight
! 
! * Volume shaders:
!         fog
!         depthcue
! 
! * Displacement shaders:
!         bumpy
!         bumptest (to test the implementation of displacements in jrMan)
! 
! * All pixel filters
! 
! * Generate image to file
! 
! 
! Renderman features not yet implemented in jrMan 0.2:
! ----------------------------------------------------
! * Shading language compiler
! * Motion blur
! * Depth of field
! * Level of detail
! * CSG
! * Nurbs and trim curves
! * Subdivision surfaces
! * Curves
! * General Polygons
! * Bicubic patches != "bezier"
! * PatchMesh
! 
! 
! Comparing jrMan 0.2 to other Renderman renderers:
! -------------------------------------------------
! We provided in the "model" directory the shading language source code for:
! glow, randomcolors and bumptest.
! 
! 
! Creating RIB files for jrMan:
! -----------------------------
! We have found the following tools useful in creating RIB files:
! 
! JPatch
! http://jpatch.sourceforge.net
! 
! Hamapatch
! http://www.geocities.com/hamapatch/program/index.html
! 
! There is also another one which should work but we haven't it tried yet:
! 
! sPatch
! http://www.geocities.com/getspatch/
! 
! Note: To generate better looking images we recomend you edit the RIB files
! generated by these tools and add these two lines near the beginning (before
! WorldBegin):
! 
! PixelSamples 4 4
! Exposure 1 2.2
! 
! 
! Finding out more about Renderman:
! ---------------------------------
! * Books:
!         The Renderman Companion
!         http://www.amazon.com/exec/obidos/tg/detail/-/0201508680/qid=1054250992/sr=1-3/ref=sr_1_3/002-1269619-5837619?v=glance&s=books
! 
!         Advanced Renderman
!         http://www.amazon.com/exec/obidos/tg/detail/-/1558606181/qid=1054251110/sr=1-1/ref=sr_1_1/002-1269619-5837619?v=glance&s=books
! 
!         The Renderman 3.2 Specification
!         https://renderman.pixar.com/
! 
! * Sites:
!         Renderman Repository
!         http://www.renderman.org/RMR/
! 
!         Renderman FAQ
!         http://www.faqs.org/faqs/graphics/renderman-faq/
!         
!         comp.graphics.rendering.renderman
!         http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&oe=UTF-8&group=comp.graphics.rendering.renderman
! 
! 
  Renderman and PhotoRealistic Renderman are trademarks of Pixar.