tupdate readme with test and update procedures - 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 c81d2057e7d0229eb3a75196b722922fb6afca35
(DIR) parent 4bcc81aef0e6cc34a85a2b8a2632130e22ba48d1
(HTM) Author: Anders Damsgaard <andersd@riseup.net>
Date: Thu, 27 Apr 2017 11:09:06 -0400
update readme with test and update procedures
Diffstat:
M README.md | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
---
(DIR) diff --git a/README.md b/README.md
t@@ -16,6 +16,21 @@ Import package contents with:
import SeaIce
+This will import all functions and data types in `SeaIce` namespace. You can
+run the package tests, which are contained in the [test/ directory](test/) with
+the following command:
+
+ Pkg.test("SeaIce")
+
+The package can be updated from this repository using:
+
+ Pkg.update("SeaIce")
+
+## Documentation
+All functions and types are documented via docstrings. The documentation can be
+displayed in the Julia shell by typing `?` followed by the function or type
+name.
+
## Author
-[Anders Damsgaard](mailto:andersd@riseup.net),
+[Anders Damsgaard](mailto:anders.damsgaard@noaa.gov),
[www.adamsgaard.dk](https://adamsgaard.dk)