better wordin for tutorial and correct versioning

JuliaDynamics · Aug 22, 2024 · bd8c5a5 · bd8c5a5
1 parent bd2c388
commit bd8c5a5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 9 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DynamicalSystems"
 uuid = "61744808-ddfa-5f27-97ff-6e42cc95d634"
 repo = "https://github.com/JuliaDynamics/DynamicalSystems.jl.git"
-version = "3.3.19"
+version = "3.3.20"
 
 [deps]
 Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"

diff --git a/docs/src/tutorial.jl b/docs/src/tutorial.jl
@@ -1,8 +1,9 @@
 # # [Overarching tutorial for DynamicalSystems.jl](@id tutorial)
 
-#nb @doc DynamicalSystems
-
-# This page serves as a short but to-the-point introduction to the **DynamicalSystems.jl** library. It outlines the core components, and how they establish an interface that is used by the rest of the library. It also provides a couple of usage examples to connect the various packages of the library together.
+# This page serves as a short but to-the-point introduction to the **DynamicalSystems.jl**
+# library. It outlines the core components, and how they establish an interface that
+# is used by the rest of the library. It also provides a couple of usage examples
+# to connect the various packages of the library together.
 
 # Going through this tutorial should take you about 20 minutes.
 
@@ -13,10 +14,12 @@
 # using Pkg; Pkg.add("DynamicalSystems")
 # ```
 
-# As discussed in the [contents](@ref contents) page, this installs several packages for the Julia language, that are all exported under a common name. To use them, simply do:
-# ```julia
-# using DynamicalSystems
-# ```
+# This installs several packages for the Julia language. These are the sub-modules/packages
+# that comprise DynamicalSystems.jl, see [contents](@ref contents) for more.
+# All of the functionality is brought into scope when doing:
+
+using DynamicalSystems
+
 # in your Julia session.
 
 # ### Package versions used
@@ -26,9 +29,12 @@ import Pkg
 #nb # Activate an environment in the folder containing the notebook
 #nb Pkg.activate(dirname(@__DIR__))
 #nb Pkg.add(["DynamicalSystems", "CairoMakie", "GLMakie", "OrdinaryDiffEq", "BenchmarkTools"])
-
 Pkg.status(["DynamicalSystems", "CairoMakie", "GLMakie", "OrdinaryDiffEq", "BenchmarkTools"]; mode = Pkg.PKGMODE_MANIFEST)
 
+#nb # ## DynamicalSystems.jl summary
+
+#nb @doc DynamicalSystems
+
 # ## Core components
 
 # The individual packages that compose `DynamicalSystems` interact flawlessly with each other because of the following two components: