Update docs. Refs #343

git-svn-id: https://svn.nexusformat.org/code/trunk@1869 ff5d1e40-2be0-497f-93bd-dc18237bd3c7
nexusformat · Feb 1, 2013 · ed76cb2 · ed76cb2
1 parent b021cce
commit ed76cb2
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 256 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -5,10 +5,10 @@ Nick Maliszewskyj <nickm@nist.gov> (CVS/ChangeLog username: ncm)
 Chris Moreton-Smith <C.M.Moreton-Smith@rl.ac.uk> (CVS/ChangeLog username: cmm)
 Ray Osborn <ROsborn@anl.gov> (CVS/ChangeLog username: rio)
 Jon Tischler <tischlerjz@ornl.gov> (CVS/ChangeLog username: jzt)
-Freddie Akeroyd	<F.A.Akeroyd@rl.ac.uk> (CVS/ChangeLog username: faa59)
+Freddie Akeroyd	<freddie.akeroyd@stfc.ac.uk> (CVS/ChangeLog username: faa59)
 Jens Krueger <jens.krueger@frm2.tum.de> (CVS/ChangeLog username: jk)
 Joern Beckmann <joern.beckmann@frm2.tum.de> (CVS/ChangeLog username: jb)
 Peter Peterson <petersonpf@ornl.gov> (CVS/ChangeLog username: pfp)
 Hartmut Gilde <Hartmut.Gilde@frm2.tum.de> (CVS/ChangeLog username: hg)
 
-$Id$
+$Id$
diff --git a/Makefile.am b/Makefile.am
@@ -34,9 +34,9 @@ CONTRIB=contrib
 endif
 SUBDIRS=third_party include src bindings applications test scripts examples doc macosx_install_kit $(CONTRIB)
 
-EXTRA_DIST=build_rules.am nexus_spec.in nexus.spec autoversion.sh \
-		build_rpm.in README.cygwin README.WIN32 README.macosx \
-		README.MinGW make_mingw_links SConstruct nexus_scons_utils.py \
+EXTRA_DIST=build_rules.am nexus_spec.in nexus.spec autogen.sh autoversion.sh \
+		build_rpm.in README.cygwin README.macosx \
+		README.MinGW make_mingw_links \
 		configure_mingw_kit Windows_extra InstallerBits \
 		README.VS2008.pdf
 

diff --git a/README b/README
@@ -3,169 +3,43 @@ NeXus - a common format for neutron and X-ray scattering data
              http://www.nexusformat.org/
 -------------------------------------------------------------------------
 
+See COPYING file for licence information
+
 Installation Instructions
 =========================
 
-Unix (including Mac OS X)
--------------------------
+Unix (including Mac OS X) source distribution
+---------------------------------------------
+
+If you have downloaded a source distribution (e.g. nexus-4.3.0.tar.gz) then you will already have a file called "configure" and the basic sequence to follow is:
+
+    ./configure  # use    sh ./configure    if this does not work
+    make
+    make check
+    make install
+
+this may not, however, build all the nexus utilities and binding you require, and may also locate the wrong HDF libraries and final installation directory. Thus you will probably need to pass some options to "configure" to control this.
+
+General information about "configure" is located in the file called INSTALL
+
+To see a list of possible options type
+
+    ./configure --help
+
+HDF libraries used by nexus are available via your system software package manager or can be downloaded from http://www.hdfgroup.org/
+
+A typical run of configure might be:
 
-We have recently changed the installation procedure to use the GNU autoconf 
-system.  This will automatically check for the relevant HDF and other libraries
-and adjust the configuration scripts accordingly.
+    ./configure --prefix=/usr/local/nexus --with-hdf5=/usr/local/hdf5
 
-1) Ensure that you have current versions of the HDF4 and/or the HDF5 
-   libraries.  It is now possible to link the NeXus libraries against 
-   either or both libraries, depending on the selected make option.
-
-   The libraries, which are available as precompiled binaries for a wide
-   range of systems, may be downloaded from:
-
-    http://www.hdfgroup.org/
+Unix (including Mac OS X) svn checkout
+--------------------------------------
 
-2) At present it is necessary to run the autogen shell script to produce the 
-   correct configure file.
+As the "configure" file mentioned is a generated file, it is not included in the version control checkout. To create it run:
 
    sh autogen.sh
 
-3) Run 'configure' and 'make'.
-
-   ./configure
-   ./make
-
-   If there are any problems, try different configure options to see if one 
-   will work.  You can see what switches are available by typing
-
-   ./configure --help
-
-4) Install the files in the default location (usually /usr/local/nexus) using
-
-   make install
-
-5) Test the installation using 
-
-   make test
-
-   The standard test procedures produce the following output:
-
- Number of global attributes:  4
-    NeXus_version = 2.0.0.
-    file_name = NXtest.nx5
-    HDF5_Version = 1.4.3
-    file_time = 2002-05-17 14:40:24-0600
- Group: entry(NXentry) contains  8 items
-    ch_data( 4)
-    Values : NeXus data
-    Subgroup: data(NXdata)
-    i1_data(20)
-    Values :   1  2  3  4
-    i2_data(22)
-    Values :   1000  2000  3000  4000
-    i4_data(24)
-    Values :      1000000     2000000     3000000     4000000
-    r4_data( 5)
-    Values :    1.00   2.00   3.00   4.00
-           :    5.00   6.00   7.00   8.00
-           :    9.00  10.00  11.00  12.00
-           :   13.00  14.00  15.00  16.00
-           :   17.00  18.00  19.00  20.00
-    r8_data( 6)
-    Values :    1.00   2.00   3.00   4.00
-           :    5.00   6.00   7.00   8.00
-           :    9.00  10.00  11.00  12.00
-           :   13.00  14.00  15.00  16.00
-           :   17.00  18.00  19.00  20.00
-       ch_attribute : NeXus
-       i4_attribute :    42
-       r4_attribute :   3.141593
-    Subgroup: sample(NXsample)
- Link Check OK
-
-   There are small differences in the formatting of the C and Fortran 
-   files.  All of them may be viewed by NXbrowse using, e.g.:
-
-   ./NXbrowse NXtest.nxs
-
-Windows
--------
-   See README.WIN32.
-
-Mac OS X
---------
-   See README.macosx
-
-VMS
----
-1) There is no VMS version of HDF5, so it is only possible to link to 
-   the HDF4 libraries.  Ensure that you have the current versions, 
-   which are available as precompiled binaries at:
-
-    http://www.hdfgroup.org/
-
-   The NeXus libraries link against the following libraries:
-
-2) Edit MAKE_VMS.COM to specify the correct location of the HDF 
-   libraries, and comment out either the F77 or F90 options if necessary.
-
-3) If you are installing the Fortran 90 library, edit NXtest.f90 to 
-   replace NXACC_CREATE5 with NXACC_CREATE4 in the first call to NXopen.
-
-4) Run MAKE_VMS.COM (i.e. type @MAKE_VMS) to build the NeXus libraries 
-   and utilities.
-
-5) Run the test programs to check the installation.
-
-   $ RUN NAPI4_TEST           (Tests C creation of NXtest.nx4)
-   $ RUN NAPIF_TEST or NXtest (Tests Fortran creation of NXtest.nxs)
-
-6) Install the NeXus libraries NEXUS.OLB and/or NEXUS90.OLB, and the 
-   include (or module) files in a standard location for building other 
-   NeXus programs.
-
-
-Comments to : ROsborn@anl.gov
-
-Argonne National Laboratory is operated by The University of Chicago for
-the U.S. Department of Energy under contract W-31-109-ENG-38.
-LEGAL POSTLUDE
---------------
-The NeXus API is free software; you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published 
-by the Free Software Foundation; either version 2.1 of the License, or
-(at your option) any later version.
-
-The NeXus API is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-
-DISCLAIMER OF LIABILITY: This document was prepared as an account of
-work sponsored by an agency of the U.S. Government. Neither the U.S.
-Government nor any agency thereof, nor the University of Chicago, nor
-any of their employees or officers, makes any warranty, express or
-implied, or assumes any legal liability or responsibility for the
-accuracy, completeness, or usefulness of any information, apparatus,
-product, or process disclosed, or represents that its use would not
-infringe privately owned rights. 
-
-DISCLAIMER OF ENDORSEMENT: Reference to any specific commercial
-product, process, or service by trade name, trademark, manufacturer,
-or otherwise does not necessarily constitute or imply its endorsement,
-recommendation, or favoring by the U.S. Government or any agency
-thereof. The views and opinions of document authors do not necessarily
-state or reflect those of the U.S. Government or any agency thereof,
-Argonne National Laboratory, or the University of Chicago.
-
-COPYRIGHT STATUS: Documents authored by Argonne National Laboratory
-employees resulted from work under U.S. Government contract
-W-31-109-ENG-38 and are subject to the following license: the
-Government is granted for itself and others acting on its behalf a
-paid-up, nonexclusive, irrevokable worldwide license in these
-documents to reproduce, prepare derivative works, and perform publicly
-and display publicly by or on behalf of the Government.
+and then follow the same procedure as above. You may also want to look at the README.developers file
 
 ----------------------------------------------------------------------------
 

diff --git a/README.MinGW b/README.MinGW
@@ -52,8 +52,3 @@ Freddie Akeroyd (F.A.Akeroyd@rl.ac.uk)
 --
 
 $Id$
-===================================================================
-RCS file: /isis/cvs/repository/nexus/applications/NXtranslate/text_xml/Makefile.am,v
-retrieving revision 1.3
-diff -r1.3 Makefile.am
-32c32
diff --git a/README.WIN32 b/README.WIN32
diff --git a/README.developers b/README.developers
@@ -49,6 +49,8 @@ you must add these to the DISTCHECK_CONFIGURE_FLAGS variable in Makefile.am
 
 To generate an RPM install kit see README.rpm
 
+Also see README.versions for setting nexus release versions
+
 If you have problems
 --------------------
 
@@ -66,14 +68,12 @@ now requires autoconf 2.61 or above
 NeXus Developer Mailing Lists
 -----------------------------
 
-CVS commit/log messages are automatically sent to the nexus-cvs@anl.gov 
-mailing list - if you wish to receive these, subscribe to the list via the link
+SVN commit/log messages are automatically sent to the nexus-code-svn@nexusformat.org mailing list - if you wish to receive these, subscribe to the list via the link
 
-  http://www.neutron.anl.gov/mailman/listinfo/nexus-cvs
+  http://lists.nexusformat.org/mailman/listinfo/nexus-code-svn
 
-Any general developer questions should be directed to nexus-developers@anl.gov 
-list - you can subscribe to this via the link
+Any general questions should be directed to nexus@nexusformat.org list - you can subscribe to this via the link
 
-  http://www.neutron.anl.gov/mailman/listinfo/nexus-developers
+  http://lists.nexusformat.org/mailman/listinfo/nexus
 
 $Id$
diff --git a/bindings/python/Makefile.am b/bindings/python/Makefile.am
@@ -38,7 +38,11 @@ EXTRA_DIST	= README.html nxs.napi.html nxstest.py run_nxstest setup.py
 
 nxs.napi.html : $(srcdir)/nxs/napi.py
 	env NEXUSLIB=../../src/.libs/libNeXus.$(SHARED_EXT) pydoc -w $(srcdir)/nxs/napi.py
-	mv napi.html $@
+	if test -r napi.html; then \
+	    mv napi.html $@; \
+	else \
+	    touch $@; \
+	fi
 
 install-data-hook :
 	sed -e "s|nxprefix = .*|nxprefix = \'${prefix}\'|" < ${srcdir}/nxs/napi.py > $(DESTDIR)${nxspythondir}/napi.py