[cig-commits] commit: changed INSTALL doc to README, and added some bits

[Mercurial]

changeset:   242:186de0396354
branch:      1.4.x
parent:      235:2989f7a758b7
user:        JulianGiordani
date:        Mon Jan 18 15:39:44 2010 +1100
files:       INSTALL README
description:
changed INSTALL doc to README, and added some bits


diff -r 2989f7a758b7 -r 186de0396354 INSTALL
--- a/INSTALL	Fri Jan 08 12:11:44 2010 +1100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,50 +0,0 @@
-========================
-  Installation Guide
-========================
-
-------------------------
-1. Dependencies
-------------------------
-
-  libXML2
-  MPI
-  PETSc
-  HDF5 (optional)
-
-(more to come)
-
-------------------------
-2. Configuration
-------------------------
-
-To configure:
-
-  ./configure.py
-
-Available options can be listed with:
-
-  ./configure.py --help
-
-------------------------
-3. Build
-------------------------
-
-To build:
-
-  ./scons.py
-
-To rebuild as fast as possible (note that this is
-not garaunteed to produce a consistent build):
-
-  ./fast-scons.py
-
-To run tests:
-
-  ./scons.py check             ... runs unit-tests & low resolution integration tests 
-  ./scons.py check-convergence ... runs only convergence tests
-  ./scons.py check-complete    ... runs all tests (recommended for cluster installs)
-
-To install:
-
-  ./scons.py install
-
diff -r 2989f7a758b7 -r 186de0396354 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Mon Jan 18 15:39:44 2010 +1100
@@ -0,0 +1,78 @@
+========================
+  README File
+========================
+
+Includes an installation guide, known bugs and contact information
+
+========================
+  Installation Guide
+========================
+
+------------------------
+1. Dependencies
+------------------------
+
+  libXML2
+  MPI
+  PETSc
+  HDF5
+
+  For visualisation (optional):
+  X11 ( for desktop machines ) or OSMesa (for cluster or machines without displays) or SDL
+  libPNG or libJPEG
+  libFAME
+
+for more details see the http://www.underworldproject.org/documentation/Dependencies.html
+
+------------------------
+2. Configuration
+------------------------
+
+To configure:
+
+  ./configure.py
+
+Available options can be listed with:
+
+  ./configure.py --help
+
+------------------------
+3. Build
+------------------------
+
+To build:
+
+  ./scons.py
+
+To rebuild as fast as possible (note that this is
+not garaunteed to produce a consistent build):
+
+  ./fast-scons.py
+
+To run tests:
+
+  ./scons.py check             ... runs unit-tests & low resolution integration tests 
+  ./scons.py check-convergence ... runs only convergence tests
+  ./scons.py check-complete    ... runs all tests (recommended for cluster installs)
+  ./scons.py -h                ... for help on the checks available
+
+
+========================
+  KNOWN ISSUES
+========================
+
+* The test, PCDVCSuite, fails under optimised mode on 32-bit machines.
+* Significant warnings are produced in compile.... don't be alarmed, we are working on them.
+
+========================
+  CONTACT INFORMATION
+========================
+Mains web page:
+  http://www.underworldproject.org/
+  
+Email groups:
+   underworld-users at vpac.org    ... user group
+   underworld-dev at vpac.org      ... developer group
+  
+
+Julian Giordani (18 Jan 2010)