This commit was generated by cvs2svn to compensate for changes in r2,

which included commits to RCS files with non-trunk default branches.

1 files changed, 61 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ac3c8a5
--- /dev/null
+++ b/README
@@ -0,0 +1,61 @@
+				     glgrav
+				     ------
+
+			An N-body gravity toy for OpenGL
+
+			   Copyright 2003 Ian Cowburn
+
+
+License
+-------
+
+glgrav comes with ABSOLUTELY NO WARRANTY; for details see LICENSE
+
+This is free software, and you are welcome to redistribute it under certain
+conditions.
+
+
+Building
+--------
+
+AS this is such a small program, there is no configure script.  Simply edit
+the makefile and follow the instructions at NOTE1, NOTE2 and NOTE3.  Then
+just :
+
+make
+
+Which (all being well) should generate the glgrav executable.
+
+Note that GCC V3.2 was used, and GCC is expected for building.  The makefile
+only includes instructions for GNU/Linux or cygwin (for windows).  Any version
+of Unix should be able to compile this too, and any platform that provides
+OpenGL and GLU/GLUT shouldn't have too much trouble building it.
+
+
+Usage
+-----
+
+glgrav [datafile]
+
+If datafile is not passed, then a file called 'dat' is searched for in the
+current directory.
+
+The datafile defines the system to simulate in glgrav.  For instructions on
+the commands available, read the supplied 'dat' file.
+
+Once running using the right mouse button will bring up a fairly self
+explanatory menu. 
+
+
+Known Bugs
+----------
+
+For some reason under Windows the first few menu items don't work.  This could
+be a bug in the GLU/GLUT code in Windows.  Or alternatively my bad coding.
+
+I've tried to organise the menus so that it shouldn't matter too much (the
+missing choices can easily be changed in the datafile).
+
+
+-------------------------------------------------------------------------------
+$Id: README,v 1.1.1.1 2006-05-02 19:12:46 ianc Exp $