commit 14ea449b6e90da5594261c7eda7efc135ee61982
parent 0f4adf040c458ca9ea8b409b7cb1ba20c5d2bf26
Author: Anders Damsgaard <andersd@riseup.net>
Date: Sun, 12 Nov 2017 11:45:29 -0500
add notes on installing Julia in the Getting Started section
Diffstat:
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/docs/src/man/getting_started.md b/docs/src/man/getting_started.md
@@ -1,11 +1,16 @@
# Getting started
-If you are new to the [Julia](https://julialang.org) programming language, the
-official manual has a useful guide to [getting started with
+In this section, it is assumed that [Julia](https://julialang.org) and
+[Granular.jl](https://github.com/anders-dc/Granular.jl) has been successfully
+installed. If not, please consult the [Installation](@ref Installation)
+section of this manual. If you are new to the [Julia](https://julialang.org)
+programming language, the official manual has a useful guide to [getting
+started with
Julia](https://docs.julialang.org/en/latest/manual/getting-started/).
In the following, two simple examples are presented using some of the core
functionality of Granular.jl. For more examples, see the scripts in the
-`examples/` directory.
+[examples/](https://github.com/anders-dc/Granular.jl/tree/master/examples)
+directory.
The relevant functions are all contained in the `Granular` module, which can be
imported with `import Granular`. *Note:* As per Julia conventions, functions
diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md
@@ -71,4 +71,3 @@ In case any of these tests fail, please open a [Github
Issue](https://github.com/anders-dc/Granular.jl/issues) describing the problems
so further investigation and diagnosis can follow.
-
