tupdate installation example - Granular.jl - Julia package for granular dynamics simulation
HTML git clone git://src.adamsgaard.dk/Granular.jl
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit 37097de110ac8523a06d1ac55cda83d66485d371
DIR parent bd8cbbc216c109985e15afae7b556da908d8e9ee
HTML Author: Anders Damsgaard <andersd@riseup.net>
Date: Tue, 12 Sep 2017 09:32:55 -0400
update installation example
Diffstat:
M docs/src/man/installation.md | 21 +++++++--------------
1 file changed, 7 insertions(+), 14 deletions(-)
---
DIR diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md
t@@ -1,8 +1,8 @@
# Installation
SeaIce.jl can be installed directly from the Julia shell by:
-```julia
-Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git")
+```julia-repl
+julia> Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git")
```
This will install the contents of this repository in the folder
t@@ -10,22 +10,15 @@ This will install the contents of this repository in the folder
is used for model restarts and is recommended but not required, and is thus not
automatically installed.
-Import the package contents into the current Julia session or script with:
-
-```julia
-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, with
+You can run the package tests, which are contained in the `test/` directory, with
the following command:
-```julia
-Pkg.test("SeaIce")
+```julia-repl
+julia> Pkg.test("SeaIce")
```
The package can be updated from this repository using:
-```julia
-Pkg.update("SeaIce")
+```julia-repl
+julia> Pkg.update("SeaIce")
```