#577 move release notes to wiki

README.md

@@ -1,31 +1,28 @@
 * NeXus: http://www.nexusformat.org/
 * documentation: http://download.nexusformat.org/doc/html/index.html
+* Release Notes: https://github.com/nexusformat/definitions/wiki/Release-Notes
 * build server: http://build.nexusformat.org/
 * travis-ci: syntax check of every NXDL file [![Build Status](https://travis-ci.org/nexusformat/definitions.svg)](https://travis-ci.org/nexusformat/definitions)
 
 These are the components that define the structure of NeXus data files 
 in the development directory.
 
-component                   | description
-----------------------------|------------------------
-LGPL.txt                    | one proposed license model
-NXDL_VERSION                | the current NXDL version number
-README.txt                  | README file
-README.make.txt             | how to build the documentation
-release-notes.md            | starting from v3.3
-applications/               | NXDL files for applications and instrument defs
-base_classes/               | NXDL files for components
-contributed_definitions/    | NXDL files from the community
-impatient-guide/            | *NeXus for the Impatient*
-jenkins_build               | configuration for Jenkins continuous integration service
-legacy_docs/                | legacy PDF copies of the NeXus definitions documentation
-manual/                     | Sphinx source files for the NeXus documentation
-nxdl.xsd                    | XML Schema for NXDL files
-nxdlTypes.xsd               | called by nxdl.xsd
-package/                    | directory for packaging this content
-utils/                      | various tools used in the definitions tree
-www/                        | launch (home) page of NeXus WWW site
-xslt/                       | various XML stylesheet transformations
-
-* See [README.make.txt](README.make.txt) for how to build the documentation
-* See [release-notes.md](release-notes.md) for what has changed since the previous release
+component                      | description
+-------------------------------|------------------------
+[BUILDING.rst](BUILDING.rst)   | how to build the documentation
+[LGPL.txt](LGPL.txt)           | one proposed license model
+NXDL_VERSION                   | the current NXDL version number
+README.md                      | this file
+applications/                  | NXDL files for applications and instrument defs
+base_classes/                  | NXDL files for components
+contributed_definitions/       | NXDL files from the community
+impatient-guide/               | *NeXus for the Impatient*
+jenkins_build                  | configuration for Jenkins continuous integration service
+legacy_docs/                   | legacy PDF copies of the NeXus definitions documentation
+manual/                        | Sphinx source files for the NeXus documentation
+[nxdl.xsd](nxdl.xsd)           | XML Schema for NXDL files
+[nxdlTypes.xsd](nxdlTypes.xsd) | called by nxdl.xsd
+package/                       | directory for packaging this content
+utils/                         | various tools used in the definitions tree
+www/                           | launch (home) page of NeXus WWW site
+xslt/                          | various XML stylesheet transformations

manual/source/installation.rst

@@ -6,9 +6,8 @@
 
 .. _Installation:
 
-============
 Installation
-============
+############
 
 .. index::
    single: NAPI; installation; download location
@@ -29,7 +28,7 @@ NeXus mailing list: http://lists.nexusformat.org/mailman/listinfo/nexus
 .. _Installation-Binary:
 
 Precompiled Binary Installation
-###############################
+*******************************
 
 
 .. _Installation-Linux:
@@ -108,7 +107,7 @@ http://download.nexusformat.org/kits/macosx/
 .. _Installation-Source:
 
 Source Installation
-###################
+*******************
 
 .. _Installation-Source-Generic:
 
@@ -149,14 +148,54 @@ distribution.
 .. _Releases:
 
 Releases
-########
+********
+
+The NeXus definitions are expected to evolve.
+The evolution is marked as a series of *releases*
+which are snapshots of the repository (and current
+state of the NeXus standard).
+Each new *release* of the definitions
+will be posted to the definitions GitHub repository
+and announced to the community via the
+NeXus mailing list: ``[email protected]``
+(http://download.nexusformat.org/doc/html/mailinglist.html#nexus-mailing-list)
 
 NeXus definitions
 =================
 
 Releases of the NeXus definitions are listed on the GitHub web site:
 https://github.com/nexusformat/definitions/releases
 
+.. index:: release; notes
+
+Release Notes
+-------------
+
+Detailed notes about each release (start with v3.3) are posted
+to the definitions GitHub wiki:
+https://github.com/nexusformat/definitions/wiki/Release-Notes
+
+.. index:: release; process
+
+Release Process
+---------------
+
+The process to make a new release of the NeXus definitions
+repository is documented in the repository's GitHub wiki:
+https://github.com/nexusformat/definitions/wiki/Release-Procedure.
+
+The release process starts by creating a GitHub 
+[Milestone](https://help.github.com/articles/tracking-the-progress-of-your-work-with-milestones/) 
+for the new release.
+Milestones for the NeXus definitions repository are
+available on the GitHub site:
+https://github.com/nexusformat/definitions/milestones
+
+.. index:: release; versioning
+
+Versioning
+----------
+
 1. each NXDL file has a ``definitions/@version`` attribute that declares the version of this NXDL file
 2. we will tag the definitions repository with new releases of the NeXus definitions
 
@@ -176,7 +215,7 @@ https://github.com/nexusformat/definitions/releases
      *major.minor* tag to point to the newest commit hash.
 
 3. changes in the NXDL language (such as new unit types) will become part of a new tag
-4. the syntax of the NXDL language is currently 3.1 (2016-10-12)
+4. the syntax of the NXDL language is currently 3.3 (2017-05-02)
 
 .. [#] *semantic versioning*: http://semver.org