From eafd08c2d65c10cd72c86d25fb9c0da95ae749ce Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Wed, 24 Jul 2019 11:04:52 +0100
Subject: [PATCH] DOC: Changelog, readme

---
 CHANGELOG.rst | 22 ++++++++++++++++++++++
 README.rst    |  4 ++++
 2 files changed, 26 insertions(+)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index ab5db7f35..a07441356 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -12,6 +12,18 @@ Added
 
 * New :mod:`.image.roi` module, for exracting an ROI of an image, or expanding
   its field-of-view.
+* New :meth:`.Image.getAffine` method, for retrieving an affine between any of
+  the voxel, FSL, or world coordinate systems.
+* New :mod:`fsl.transforms` package, which contains classes and functions for
+  working with linear and non-linear FLIRT and FNIRT transformations.
+* New static methods :meth:`.Nifti.determineShape`,
+  :meth:`.Nifti.determineAffine`, :meth:`.Nifti.generateAffines`, and
+  :meth:`.Nifti.identifyAffine`.
+* New prototype :mod:`fsl.transforms.x5`  module, for reading/writing linear
+  and non-linear X5 files (*preliminary release, subject to change*).
+* New prototype :mod:`.fsl_convert_x5` :mod:`.fsl_apply_x5` programs, for
+  working with X5 transformations (*preliminary release, subject to change*).
+
 
 
 Changed
@@ -20,6 +32,16 @@ Changed
 
 * The :mod:`.resample_image` script has been updated to support resampling of
   images with more than 3 dimensions.
+* `h5py <https://www.h5py.org/>`_ has been added to the ``fslpy`` dependencies.
+
+
+Deprecated
+^^^^^^^^^^
+
+
+* The :mod:`fsl.utils.transform` module has been deprecated its functions can
+  now be found in the :mod:`fsl.transforms.affine` and
+  :mod:`fsl.transform.flirt` modules.
 
 
 2.3.1 (Friday July 5th 2019)
diff --git a/README.rst b/README.rst
index ac2f6b895..6b0f069bb 100644
--- a/README.rst
+++ b/README.rst
@@ -91,6 +91,10 @@ The ``rtree`` library assumes that ``libspatialindex`` is installed on
 your system.
 
 
+The :mod:`fsl.transform.x5` module uses `h5py <https://www.h5py.org/>`_,
+which requires ``libhdf5``.
+
+
 Documentation
 -------------
 
-- 
GitLab