Improve READMEs etc

6 files changed, 39 insertions, 28 deletions

diff --git a/INSTALL.md b/INSTALL.md
index 9f5761f..99ddc38 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,6 +1,15 @@
 # hmatrix installation
 
-This package requires [GHC 7.8](http://www.haskell.org/ghc), [cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install) (available in the [Haskell Platform](http://hackage.haskell.org/platform)), and the development packages for BLAS/[LAPACK](http://www.netlib.org/lapack) and [GSL](http://www.gnu.org/software/gsl).
+*WARNING*: these instructions are now very out of date. However, there
+is a CI script which shows what does work; you are advised to look at
+that and emulate its installation steps.
+
+This package requires [GHC 7.8](http://www.haskell.org/ghc),
+[cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install)
+(available in the [Haskell
+Platform](http://hackage.haskell.org/platform)), and the development
+packages for BLAS/[LAPACK](http://www.netlib.org/lapack) and
+[GSL](http://www.gnu.org/software/gsl).
 
 ## Linux ##################################################
 
diff --git a/README.md b/README.md
index cdbcf85..de7f523 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,22 @@
 A Haskell library for numerical computation
 -------------------------------------------
 
-A purely functional interface to linear algebra and other numerical algorithms, internally implemented using [LAPACK][lapack], [BLAS][blas], and [GSL][gsl].
+A purely functional interface to linear algebra and other numerical
+algorithms, internally implemented using [LAPACK][lapack],
+[BLAS][blas], [GSL][gsl] and [SUNDIALS][sundials].
 
-This package includes matrix decompositions (eigensystems, singular values, Cholesky, QR, etc.), linear solvers, numeric integration, root finding, etc.
+This package includes matrix decompositions (eigensystems, singular
+values, Cholesky, QR, etc.), linear solvers, numeric integration, root
+finding, etc.
 
-- [What's new][changes] in version 0.17 (July 2015)
+- [What's new][changes] in version 0.19 (April 2018). This is not
+  intended to be a breaking change but a lot of modules have been
+  modified to ensure that continuous integration is green.
+
+- Support for SUNDIALS has been added. It should be possible to
+  replace Numeric.GSL.ODE with Numeric.Sundials.ARKode.ODE and have
+  your program work as before bearing in mind that the methods and
+  error control might differ (even for those with the same names!).
 
 - [Code examples][examples]
 
@@ -26,6 +37,7 @@ Contributions, suggestions, and bug reports are welcome!
 [lapack]: http://www.netlib.org/lapack/
 [blas]: http://www.netlib.org/blas/
 [gsl]: http://www.gnu.org/software/gsl/
+[sundials]: https://computation.llnl.gov/projects/sundials
 
 [tutorial]: http://dis.um.es/profesores/alberto/material/hmatrix.pdf
 [installation]: https://github.com/AlbertoRuiz/hmatrix/blob/master/INSTALL.md
diff --git a/packages/base/CHANGELOG b/packages/base/CHANGELOG
index 11a57dd..fd1c171 100644
--- a/packages/base/CHANGELOG
+++ b/packages/base/CHANGELOG
@@ -2,15 +2,15 @@
 --------
 
     * Many new functions and instances in the Static module
-    
+
     * meanCov and gaussianSample use Herm type
 
     * thinQR, thinRQ
-    
+
     * compactSVDTol
 
     * unitary changed to normalize, also admits Vector (Complex Double)
-  
+
 0.17.0.0
 --------
 
@@ -288,4 +288,3 @@
     * added NFData instances for Matrix and Vector.
 
     * liftVector, liftVector2 replaced by mapVector, zipVector.
-
diff --git a/packages/gsl/CHANGELOG b/packages/gsl/CHANGELOG
index 091dc0e..a2fe038 100644
--- a/packages/gsl/CHANGELOG
+++ b/packages/gsl/CHANGELOG
@@ -2,7 +2,7 @@
 --------
 
     * Added interpolation modules
-    
+
     * Added simulated annealing module
 
     * Added odeSolveVWith
@@ -11,4 +11,3 @@
 --------
 
     * The modules Numeric.GSL.* have been moved from hmatrix to the new package hmatrix-gsl.
-
diff --git a/packages/sundials/ChangeLog.md b/packages/sundials/ChangeLog.md
index e95dc4e..7b15777 100644
--- a/packages/sundials/ChangeLog.md
+++ b/packages/sundials/ChangeLog.md
@@ -1,5 +1,5 @@
-# Revision history for sundials
+# Revision history for hmatrix-sundials
 
-## 0.1.0.0  -- YYYY-mm-dd
+## 0.1.0.0  -- 2018-04-21
 
-* First version. Released on an unsuspecting world.
+* First version. Released on an unsuspecting world. Just Runge-Kutta methods to start with.
diff --git a/packages/sundials/README.md b/packages/sundials/README.md
index 400b36f..2fac5c2 100644
--- a/packages/sundials/README.md
+++ b/packages/sundials/README.md
@@ -1,16 +1,8 @@
-I think this builds the executable. I haven't tried cleaning
-everything yet to double check.
+Currently only an interface to the Runge-Kutta methods:
+[ARKode](https://computation.llnl.gov/projects/sundials/arkode)
 
-```
-cabal install
-cd src
-/nix/store/qrwfai93qhdaj5d4xd34n9bq58slzfxw-gcc-wrapper-6.4.0/bin/gcc -c helpers.c -I/nix/store/dr0yrlmscybjs5ifzw1m063g6xgw5imq-ghc-8.2.2-with-packages/lib/ghc-8.2.2/include
-cd ..
-ghc src/Main.hs src/helpers.o -lsundials_arkode -o Main
-```
-
-To run you will (on MACos) also need
-
-```
-export DYLD_LIBRARY_PATH=~/.cabal/bin:/nix/store/dr0yrlmscybjs5ifzw1m063g6xgw5imq-ghc-8.2.2-with-packages/lib/ghc-8.2.2/rts
-```
\ No newline at end of file
+The interface is almost certainly going to change. Sundials gives a
+rich set of "combinators" for controlling the solution of your problem
+and reporting on how it performed. The idea is to initially mimic
+hmatrix-gsl and add extra, richer functions but ultimately upgrade the
+whole interface both for sundials and for gsl.