tupdate documentation - Granular.jl - Julia package for granular dynamics simulation
(HTM) git clone git://src.adamsgaard.dk/Granular.jl
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 90c05bbf6bc7a073e6e2995795e271ec7aa535d9
(DIR) parent 8017ec8c0fbb60b531e5ccd4a2e2eac696def195
(HTM) Author: Anders Damsgaard <andersd@riseup.net>
Date: Mon, 11 Sep 2017 11:09:41 -0400
update documentation
Diffstat:
M docs/src/index.md | 10 +++++++++-
M docs/src/man/installation.md | 4 ++--
2 files changed, 11 insertions(+), 3 deletions(-)
---
(DIR) diff --git a/docs/src/index.md b/docs/src/index.md
t@@ -1,6 +1,6 @@
# SeaIce.jl
-*Package for particle-based simulation of sea-ice dynamics*
+*A [Julia](https://julialang.org) package for particle-based simulation of sea-ice dynamics.*
## Package features
t@@ -8,6 +8,14 @@ Flexible and computationally efficient 2d implementation of the discrete element
See the [Index](@ref main-index) for the complete list of documented functions and types.
+---
+
+### Author
+[Anders Damsgaard](https://adamsgaard.dk), Geophysical Fluid Dynamics Laboratory, Princeton University.
+
+### License
+SeaIce.jl is licensed under the GPLv3; see [LICENSE](https://github.com/anders-dc/SeaIce.jl/blob/master/LICENSE.md) for the full license text.
+
## Manual Outline
```@contents
(DIR) diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md
t@@ -14,8 +14,8 @@ Import the package contents into the current Julia session or script with:
import SeaIce
This will import all functions and data types in the `SeaIce` namespace. You
-can run the package tests, which are contained in the [test/ directory](test/),
-with the following command:
+can run the package tests, which are contained in the `test/` directory, with
+the following command:
Pkg.test("SeaIce")