explain that Plots.jl must be installed

Closes #15
PoisotLab · Jul 24, 2020 · 89e3172 · 89e3172
1 parent 2c3e613
commit 89e3172
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,9 @@
 
 This package provides plotting abilities for `EcologicalNetworks.jl`. It uses
 `RecipesBase.jl` to do the plotting through `Plots.jl`. The package currently
-generates force-directed layouts, circular layouts, bipartite layouts, heatmaps,
-as well as layouts based on node properties.
+generates force-directed layouts, circular layouts, bipartite layouts,
+heatmaps, as well as layouts based on node properties. Note that `Plots.jl`
+*must* be installed in the project, and loaded, for this package to work.
 
 **Documentation:** [Stable](https://poisotlab.github.io/EcologicalNetworksPlots.jl/stable/) `//` [Latest](https://poisotlab.github.io/EcologicalNetworksPlots.jl/latest/)
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,7 +1,7 @@
 The `EcologicalNetworksPlots` package extends `EcologicalNetworks` to provide
-plotting functionalities, by allowing network objects to be used with `Plots`.
-This documentation has a complete reference of the functions and types, as well
-as a gallery of examples.
+plotting functionalities, by allowing network objects to be used with `Plots`,
+which *must* also be installed and loaded. This documentation has a complete
+reference of the functions and types, as well as a gallery of examples.
 
 Plotting a network can be done in two ways. First, as a `heatmap`, in which case
 no arguments are necessary. Second, as the usual nodes and links visualization.
@@ -15,9 +15,9 @@ more calls to `position!`. The *nodes* in the network are represented using
 Probabilistic networks have link *probability* denoted as transparency, and
 quantitative network have link *strength* represented as width.
 
-Both the fill and color of the nodes can be changed, using the `nodefill` and
-`nodesize` arguments -- these must be dictionnaries mapping *all nodes* in the
-network to a single numerical value, and they affect the `markerfill` and
+Both the fill and color of the nodes can be changed, using the `nodefill`
+and `nodesize` arguments -- these must be dictionaries mapping *all nodes* in
+the network to a single numerical value, and they affect the `markerfill` and
 `markerz` value of `Plots`, respectively. Note that by default, `frametype` is
 `:none` and `legend` is `false`, but this can be changed. It is particularly
 important to change it for `UnravelledLayout`, for example.