tupdate README reflecting admission to the Julia repository - Granular.jl - Jul… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 2f24a09c7a4b74f8f45d3ab96f459a135018e546 | |
parent 2f86b2f3bb054dd34b2ea35c1a65ebe455b15646 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Sat, 4 Nov 2017 22:54:17 -0400 | |
update README reflecting admission to the Julia repository | |
Diffstat: | |
M README.md | 26 ++++++++++++++------------ | |
1 file changed, 14 insertions(+), 12 deletions(-) | |
--- | |
diff --git a/README.md b/README.md | |
t@@ -10,30 +10,32 @@ A [Julia](https://julialang.org) package for granular mech… | |
|[![Granular.jl Documentation](https://img.shields.io/badge/docs-latest-blue.s… | |
## Installation | |
-[Granular.jl](https://github.com/anders-dc/Granular.jl) is not yet registered | |
-in the [official Julia package repository](https://pkg.julialang.org), but can | |
-be installed directly from the Julia shell by: | |
+[Granular.jl](https://github.com/anders-dc/Granular.jl) is registered in the | |
+[official Julia package repository](https://pkg.julialang.o,rg), and the lates… | |
+release can be installed directly from the Julia shell by: | |
```julia | |
-julia> Pkg.clone("git://github.com/anders-dc/Granular.jl") | |
+julia> Pkg.add("Granular.jl") | |
``` | |
-This will install the contents of this repository in the folder | |
-`~/.julia/v$(JULIA_VERSION)/Granular`, and install the packages specified as | |
-[requirements](REQUIRE). You can run the package tests, which are contained in | |
-the [test/ directory](test/), with the following command: | |
+If you want to install the latest development version from the Github | |
+repository, instead install the package with: | |
```julia | |
-julia> Pkg.test("Granular") | |
+julia> Pkg.clone("git://github.com/anders-dc/Granular.jl") | |
``` | |
-The package can be updated from this repository using: | |
+The package contents will be installed in the folder | |
+`~/.julia/v$(JULIA_VERSION)/Granular`, and the packages specified as | |
+[requirements](REQUIRE). You can run the package tests, which are contained in | |
+the [test/ directory](test/), with the following command: | |
```julia | |
-julia> Pkg.update("Granular") | |
+julia> Pkg.test("Granular") | |
``` | |
-For more information on installation and usage, please refer to the [documenta… | |
+For more information on installation and usage, please refer to the | |
+[documentation](https://anders-dc.github.io/Granular.jl/latest). | |
## Author | |
[Anders Damsgaard](https://adamsgaard.dk), Geophysical Fluid Dynamics Laborato… |