Create a changelog, & include in docs

CHANGES.rst

@@ -0,0 +1,4 @@
+0.1 (unreleased)
+----------------
+
+Initial release

README.rst

@@ -5,12 +5,12 @@ Gunagala
     :target: http://www.astropy.org
     :alt: Powered by Astropy Badge
 
-This is a Python package for modelling the performance of astronomical instruments, including SNR/ETC/sensitivity limit
-calculations and generation of simulated data. The documentation is at
+This is a Python package for modelling the performance of astronomical instruments, including
+SNR/ETC/sensitivity limit calculations and generation of simulated data. The documentation is at
 `gunagala.readthedocs.io <https://gunagala.readthedocs.io/en/latest/>`_
 
-Gunagala is the word for sky in Kamilaroi/Gamilaraay, the language of the Traditional Custodians of the land on which Siding
-Spring Observatory sits
+Gunagala is the word for sky in Kamilaroi/Gamilaraay, the language of the Traditional Custodians of
+the land on which Siding Spring Observatory sits
 (ref: `www.dnathan.com <https://www.dnathan.com/language/gamilaraay/dictionary/GAM_G.HTM#gunagala>`_).
 
 .. image:: https://travis-ci.org/AstroHuntsman/gunagala.svg

docs/index.rst

@@ -5,20 +5,22 @@ Gunagala
 Introduction
 ============
 
-Gungala is a Python package for modelling the performance of astronomical instruments, including SNR/ETC/sensitivity
-limit calculations and generation of simulated data.
-
-This package is not intended for rigorous, end-to-end simulations of telescope and instrument systems. Instead gunagala
-implements parameterised models of instrument components in order to enable rapid, efficient evaluation of instrument
-performance. Anticipated uses include exposure time calculators, selection of commercial off the shelf components and
-exploration of the design parameter space for custom components.
-
-Gunagala includes a library of performance parameters for a number of existing commercial off the shelf instrument
-components (e.g. CCD cameras, optical filters, telescopes and camera lenses) and the user can easily add new/custom
-components either through YAML based config files or programmatically in Python.
-
-Gunagala is the word for sky in Kamilaroi/Gamilaraay, the language of the Traditional Custodians of the land on which Siding
-Spring Observatory sits
+Gungala is a Python package for modelling the performance of astronomical instruments, including
+SNR/ETC/sensitivity limit calculations and generation of simulated data.
+
+This package is not intended for rigorous, end-to-end simulations of telescope and instrument
+systems. Instead gunagala implements parameterised models of instrument components in order to
+enable rapid, efficient evaluation of instrument performance. Anticipated uses include exposure time
+calculators, selection of commercial off the shelf components and exploration of the design
+parameter space for custom components.
+
+Gunagala includes a library of performance parameters for a number of existing commercial off the
+shelf instrument components (e.g. CCD cameras, optical filters, telescopes and camera lenses) and
+the user can easily add new/custom components either through YAML based config files or
+programmatically in Python.
+
+Gunagala is the word for sky in Kamilaroi/Gamilaraay, the language of the Traditional Custodians of
+the land on which Siding Spring Observatory sits
 (ref: `www.dnathan.com <http://www.dnathan.com/language/gamilaraay/dictionary/GAM_G.HTM#gunagala>`_).
 
 Installation
@@ -36,37 +38,40 @@ Alternatively to install in 'editable mode' use::
 
   $ pip install -e git+https://github.com/AstroHuntsman/gunagala.git
 
-Depending on the configuration of your system you may want to use `pip`'s ``--user`` or ``--root`` options to change
-the install location. See the pip documentation for details.
+Depending on the configuration of your system you may want to use `pip`'s ``--user`` or ``--root``
+options to change the install location. See the pip documentation for details.
 
-`Pip` will automatically install the Python packages required by Gunagala (`numpy`, `scipy`, `astropy`, `PyYAML`,
-`matplotlib` and their dependencies) if they are not already installed. If you want to install specific versions
-of the required packages from other sources do this before installing Gunagala.
+`Pip` will automatically install the Python packages required by Gunagala (`numpy`, `scipy`,
+`astropy`, `PyYAML`, `matplotlib` and their dependencies) if they are not already installed. If you
+want to install specific versions of the required packages from other sources do this before
+installing Gunagala.
 
 Installing from source
 ----------------------
 
-The project source is in a GitHub repository at https://github.com/AstroHuntsman/gunagala. To install using git on the
-command line::
+The project source is in a GitHub repository at https://github.com/AstroHuntsman/gunagala. To
+install using git on the command line::
 
   $ cd ~/Build
   $ git clone https://github.com/AstroHuntsman/gunagala.git
   $ cd gunagala
   $ python setup.py install
 
-Alternatively if you expect to make changes to the Gunagala code install with the ``develop`` command instead::
+Alternatively if you expect to make changes to the Gunagala code install with the ``develop``
+command instead::
 
   $ python setup.py develop
 
-Setuptools will automatically install the Python packages required by Gunagala (`numpy`, `scipy`, `astropy`,
-`PyYAML`, `matplotlib` and their dependencies) if they are not already installed. If you want to install specific
-versions of the required packages from other sources do this before installing Gunagala.
+Setuptools will automatically install the Python packages required by Gunagala (`numpy`, `scipy`,
+`astropy`, `PyYAML`, `matplotlib` and their dependencies) if they are not already installed. If you
+want to install specific versions of the required packages from other sources do this before
+installing Gunagala.
 
 Running the test suite
 ----------------------
 
-After installing Gunagala it is recommended that you run the suite of units tests. This can be done at the command line
-using::
+After installing Gunagala it is recommended that you run the suite of units tests. This can be done
+at the command line using::
 
   $ python setup.py test
 
@@ -80,24 +85,24 @@ or from within a Python interpreter with::
 Examples
 ========
 
-The Gunagala package includes several examples in the form of `Jupyter <https://jupyter.org>`_ notebooks. These can be
-found in the `gungala/examples` directory after installing Gunagala, or they can be viewed directly in the GitHub
-repository by going to https://github.com/AstroHuntsman/gunagala/tree/master/examples and clicking on the ``.ipynb``
-files.
+The Gunagala package includes several examples in the form of `Jupyter <https://jupyter.org>`_
+notebooks. These can be found in the `gungala/examples` directory after installing Gunagala, or they
+can be viewed directly in the GitHub repository by going to
+https://github.com/AstroHuntsman/gunagala/tree/master/examples and clicking on the ``.ipynb`` files.
 
 Contributing
 ============
 
 Please submit bug reports or feature requests in the form of GitHub Issues at
-https://github.com/AstroHuntsman/gunagala/issues. For code contributions please fork and clone the repository, create a
-feature branch and submit a Pull Request.  We recommend the
-`astropy Developer Documentation <http://docs.astropy.org/en/stable/development/workflow/development_workflow.html>`_
+https://github.com/AstroHuntsman/gunagala/issues. For code contributions please fork and clone the
+repository, create a feature branch and submit a Pull Request.  We recommend the `astropy Developer
+Documentation <http://docs.astropy.org/en/stable/development/workflow/development_workflow.html>`_
 for a description of suitable workflows.
 
 Changelog
 =========
 
-Coming soon...
+.. include:: ../CHANGES.rst
 
 Reference/API
 =============