commit 3ddfb848626100230bbabd79a1669a62ae45f94b
parent eef611de8522c106573dd4104309929a38fa9b33
Author: Anders Damsgaard <andersd@riseup.net>
Date: Tue, 7 Nov 2017 10:18:28 -0500
update documentation with information on testing
Diffstat:
1 file changed, 31 insertions(+), 3 deletions(-)
diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md
@@ -1,5 +1,8 @@
# Installation
-Granular.jl can be installed directly from the Julia shell by:
+
+## Stable installation (recommended)
+The latest stable release of Granular.jl can be installed directly from the
+Julia shell by:
```julia-repl
julia> Pkg.add("Granular")
@@ -10,9 +13,34 @@ This will install the contents of this repository in the folder
package [JLD](https://github.com/JuliaIO/JLD.jl) is used for model restarts and
is recommended but not required, and is thus not automatically installed.
-You can run the package tests, which are contained in the `test/` directory, with
-the following command:
+If desired, the current developmental version of the [Granular.jl Github
+repository](https://github.com/anders-dc/Granular.jl) can be installed with the
+command:
+
+```julia-repl
+julia> Pkg.clone("git://github.com/anders-dc/Granular.jl")
+```
+
+*Please note:* The developmental version is considered unstable and should only
+be used over the stable version if there is a compelling reason to do so.
+
+## Package tests
+The Granular.jl package contains many tests that verify that the functionality
+works as intended. The extent of test coverage of the source code is monitored
+and published with [CodeCov](https://codecov.io/gh/anders-dc/Granular.jl).
+
+The package tests are during development continuously run with
+[Travis-CI](https://travis-ci.org/anders-dc/Granular.jl) for Mac (latest stable
+release) and Linux (Ubuntu stable (trusty)), and
+[AppVeyor](https://ci.appveyor.com/project/anders-dc/seaice-jl) for Windows.
+
+The test scripts are contained in the `test/` directory, can be run locally
+with the following command:
```julia-repl
julia> Pkg.test("Granular")
```
+
+In case any of these tests fail, please open a [Github
+Issue](https://github.com/anders-dc/Granular.jl/issues) so it can be
+investigated and diagnosed further.
