tupdate README and refer to the documentation - Granular.jl - Julia package for… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 2d6aac60ca334dc2507a1b9190105e23517c7f8a | |
parent 37097de110ac8523a06d1ac55cda83d66485d371 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Tue, 12 Sep 2017 09:37:36 -0400 | |
update README and refer to the documentation | |
Diffstat: | |
M README.md | 27 +++++++++++++-------------- | |
1 file changed, 13 insertions(+), 14 deletions(-) | |
--- | |
diff --git a/README.md b/README.md | |
t@@ -10,27 +10,26 @@ A [Julia](https://julialang.org) package for sea-ice granu… | |
not yet ready for third-party use. If you know better install it directly fro… | |
the Julia shell by: | |
- Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git") | |
+```julia | |
+julia> Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git") | |
+``` | |
This will install the contents of this repository in the folder | |
`~/.julia/v$(JULIA_VERSION)/SeaIce`, and install the packages specified as | |
-[requirements](REQUIRE). The package [JLD](https://github.com/JuliaIO/JLD.jl) | |
-is used for model restarts and is recommended but not required, and thus is no… | |
-automatically installed. | |
+[requirements](REQUIRE). You can run the package tests, which are contained in | |
+the [test/ directory](test/), with the following command: | |
-Import the package contents into the current Julia session 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: | |
- | |
- Pkg.test("SeaIce") | |
+```julia | |
+julia> Pkg.test("SeaIce") | |
+``` | |
The package can be updated from this repository using: | |
- Pkg.update("SeaIce") | |
+```julia | |
+julia> Pkg.update("SeaIce") | |
+``` | |
+ | |
+For more information on installation and usage, please refer to the [documenta… | |
## Author | |
[Anders Damsgaard](mailto:[email protected]), |