commit bd8cbbc216c109985e15afae7b556da908d8e9ee
parent 7ff4993c5afbc4bf700bb51d91d1e6a16ceb27ca
Author: Anders Damsgaard <andersd@riseup.net>
Date: Mon, 11 Sep 2017 18:45:49 -0400
set language for code snippets
Diffstat:
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md
@@ -1,7 +1,9 @@
# Installation
SeaIce.jl can be installed directly from the Julia shell by:
- Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git")
+```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 its requirements. The package [JLD](https://github.com/JuliaIO/JLD.jl)
@@ -10,14 +12,20 @@ automatically installed.
Import the package contents into the current Julia session or script with:
- import SeaIce
+```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
the following command:
- Pkg.test("SeaIce")
+```julia
+Pkg.test("SeaIce")
+```
The package can be updated from this repository using:
- Pkg.update("SeaIce")
+```julia
+Pkg.update("SeaIce")
+```