Revised README.txt and INSTALL files
authorAnthony Stone <ajs1@cam.ac.uk>
Fri, 26 Oct 2018 10:56:00 +0000 (11:56 +0100)
committerAnthony Stone <ajs1@cam.ac.uk>
Fri, 26 Oct 2018 11:01:07 +0000 (12:01 +0100)
INSTALL
README.txt [new file with mode: 0644]

diff --git a/INSTALL b/INSTALL
index 0520cc8..f1d2158 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,87 +1,36 @@
-Orient 4.9 Installation
+Orient 5.0 Installation
 -----------------------
 
-In the following, replace "4.9.nn" by the version number of your copy
-of the program.
-
-Installing the binary executable:
-
-1.  Put the files Orient-4.9.nn-<arch>-<compiler>.tgz and
-    Orient-4.9.nn-base.tgz in a suitable directory. <arch> is your
-    machine architecture and operating system (x86-64 or osx) and
-    <compiler> specifies the particular binary if there is more than
-    one for your operating system. Run the commands
-
-       tar xzvf Orient-4.9.nn-base.tgz
-       tar xzvf Orient-4.9.nn-<arch>-<compiler>.tgz
-
-    This will create a new directory Orient-4.9.nn containing the
-    program, test files and documentation.
-
-2.  If you choose a binary version that includes the OpenGL display
-    routines, you will probably need to set the environment variable
-    LD_LIBRARY_PATH to the directory containing the OpenGL and X
-    routines. On modern Linux systems they are usually in /usr/lib64
-    or /usr/lib.
-
-2.  To install the binary in INSTALL_DIR:
-    Check first that the value of this variable is set correctly in
-    Orient-4.9.nn/Makefile. Then, in the directory Orient-4.9.nn, run
-    (as root, if necessary)
-
-       make install
-  
-3.  Now run
-
-       make test
-
-    which should run a series of test jobs. Results will appear in the
-    subdirectories of the directory Orient-4.9.nn/tests. The test scripts
-    use Perl to check whether the results are acceptable. If you do
-    not have Perl, remove the "#" from the line "#PERL = -noperl" in
-    Orient-4.9.nn/tests/Makefile. In this case a cruder check will be
-    carried out, and most tests will appear to fail because of
-    differences between compilers or architectures that lead to
-    slightly different results because of rounding errors, differences
-    in timing, and so forth. If so it will be necessary to compare the
-    output files by hand and to judge whether the errors are
-    significant. Better to install Perl!
-
-
 Installing from source:
 
-1.  Put the files Orient-4.9.nn-base.tgz (if not already installed) and
-    Orient-4.9.nn-source.tgz in a suitable directory and run the
-    commands
-
-       tar xzf Orient-4.9.nn-base.tgz
-       tar xzf Orient-4.9.nn-source.tgz
-
-    This will create a new directory Orient-4.9.nn (unless it already
-    exists) containing the program, test files and documentation.
+1.  In a suitable directory, run the command
+      git clone ch-stone@git.uis.cam.ac.uk:u/ajs1/Orient
+    This will construct a clone of the program files in the
+    subdirectory Orient. Change to this directory.
 
 2.  Inspect the variables defined at the top of the Makefile in the
-    Orient-4.9.nn directory, and correct the values as necessary. You
+    Orient directory, and correct the values as necessary. You
     may want to set the COMPILER variable to a different value. You
     will also need to check that the paths to the various library
     directories are correct. You will need to have the Lapack and Blas
     subroutine libraries installed; the ATLAS (Automatically Tuned
     Linear Algebra Software) library is recommended. If you want to
     compile with the graphical display features included, you will
-    need a Fortran 2003 compiler that includes the C interoperability
-    features, and you need to have the OpenGL libraries installed.
+    need a Fortran 2003 or later compiler that includes the C
+    interoperability features, and you need to have the OpenGL
+    libraries installed.
 
-3.  Check the settings in the Orient-4.9.nn/<arch>/<compiler>/Flags
+3.  Check the settings in the Orient/<arch>/<compiler>/Flags
     file, where <arch> is your machine architecture and operating
     system and <compiler> the compiler that you intend to use. You may
-    need to make a directory Orient-4.9.nn/<arch>/<compiler> if it
+    need to make a directory Orient/<arch>/<compiler> if it
     isn't already present. In this case also make a directory
-    Orient-4.9.nn/<arch>/<compiler>/exe, and provide a file
-    Orient-4.9.nn/<arch>/<compiler>/Flags containing the necessary
+    Orient/<arch>/<compiler>/exe, and provide a file
+    Orient/<arch>/<compiler>/Flags containing the necessary
     compiler flags. You can copy the Flags file from one of the other
     directories and modify it as necessary.
 
-4.  Change to the Orient-4.9.nn directory and run the command 
+4.  Change to the Orient directory and run the command 
 
        make [COMPILER=compiler] [OPENGL=no]
 
@@ -91,12 +40,17 @@ Installing from source:
     OPENGL=no (but they are provided as standard under most operating
     systems).
 
-5.  Run
+5.  The Orient executable should appear as
+    Orient/<arch>/<compiler>/exe/orient, with a symbolic link to it
+    from Orient/bin/orient.
+
+5.  Still in the Orient directory, run
 
       make test
 
-    as above. If you compile with OPENGL=no the formamide test will
-    fail, because it tries to use the display routines. 
+    If you compile with OPENGL=no the formamide test will fail,
+    because it tries to use the display routines.
+
 
 
 Please notify me of any bugs that you find. Suggestions for fixing
diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..0da55de
--- /dev/null
@@ -0,0 +1,40 @@
+                               ORIENT 5.0
+
+                          by Anthony Stone
+
+                        with contributions from
+       Andreas Dullweber, Ola Engkvist, Elena Fraschini, Matt Hodges,
+          Andy Meredith, David Nutt, Paul Popelier and David Wales
+
+
+The Orient program provides tools for the development and evaluation
+of analytical models of interactions between molecules, or between
+molecules and solid surfaces. It does not provide any models itself;
+they have to be obtained elsewhere, for example by using the CamCASP
+program of Misquitta and Stone.
+
+Obtaining the program
+---------------------
+
+In a suitable directory, run the command
+  git clone ch-stone@git.uis.cam.ac.uk:u/ajs1/Orient
+This will construct a clone of the program files in the subdirectory
+Orient.
+
+Documentation
+-------------
+
+Full documentation is in Orient/doc/Manual.pdf.
+
+Registration
+------------
+
+It is no longer necessary to apply for a licence to use this program.
+The program is distributed under the GNU General Public Licence (GPL).
+See the file Orient/doc/gpl-3.0.pdf for full details.
+
+Installation
+------------
+
+Please see the file Orient/INSTALL for installation instructions.
+