Update example and docs

Co-Authored-By: Claudio Moroni <[email protected]>
Co-Authored-By: Pietro Monticone <[email protected]>

Author: 3 people

docs/src/index.md

@@ -64,6 +64,13 @@ Pkg.add(url="https://github.com/JuliaGraphs/MultilayerGraphs.jl")
 Here we illustrate how to define, handle and analyse a `MultilayerGraph` (the directed version is completely analogous).
 
 ```julia
+# Install necessary tutorial dependencies 
+using Pkg
+Pkg.add(["Revise", "Distributions", "SimpleValueGraph", 
+         "LoggingExtras", "StatsBase", "SimpleWeightedGraphs", 
+         "MetaGraphs", "Agents", "MultilayerGraphs"])
+
+# Import necessary tutorial dependencies
 using Revise
 using StatsBase, Distributions
 using Graphs, SimpleWeightedGraphs, MetaGraphs, SimpleValueGraphs
@@ -116,7 +123,7 @@ MultilayerVertex(
 )
 ```
 
-Let's contruct a list of `MultilayerVertex`s to use in the remainder of the tutorial:
+Let's construct a list of `MultilayerVertex`s to use in the remainder of the tutorial:
 
 ```julia
 ## Convert nodes to multilayer vertices without metadata

example/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
+MultilayerGraphs = "af984530-d72f-4904-8b81-b992bbbeaf3f"
+SimpleValueGraphs = "b43c691f-cac2-5415-8122-396fe16a49fc"

example/example.md renamed to example/README.md

@@ -23,6 +23,12 @@ Pkg.add(url="https://github.com/JuliaGraphs/MultilayerGraphs.jl")
 Let's begin by importing the necessary dependencies and setting the relevant constants.
 
 ```julia
+# Import the package manager 
+using Pkg
+# Activate the environment 
+Pkg.activate(@__DIR__)
+# Instantiate the environment 
+Pkg.instantiate()
 # Import necessary dependencies
 using Distributions, Graphs, SimpleValueGraphs
 using MultilayerGraphs

example/example.jl

@@ -1,3 +1,14 @@
+#################################################
+################# ENVIRONMENT ###################
+#################################################
+
+# Import the package manager 
+using Pkg
+# Activate the environment 
+Pkg.activate(@__DIR__)
+# Instantiate the environment 
+Pkg.instantiate()
+
 #################################################
 ################### PACKAGES ####################
 #################################################