Merge pull request #27 from railtoolkit/development

updated README.md

.github/workflows/CI.yml

@@ -11,6 +11,7 @@ on:
       - 'README.md'
       - '.github/workflows/cffvalidation.yml'
       - '.github/workflows/CompatHelper.yml'
+      - '.github/workflows/debug.yml'
       - '.github/workflows/JuliaRegister.yml'
       - '.github/workflows/release.yml'
       - '.github/workflows/TagBot.yml'
@@ -26,6 +27,7 @@ on:
       - 'README.md'
       - '.github/workflows/cffvalidation.yml'
       - '.github/workflows/CompatHelper.yml'
+      - '.github/workflows/debug.yml'
       - '.github/workflows/JuliaRegister.yml'
       - '.github/workflows/release.yml'
       - '.github/workflows/TagBot.yml'
@@ -55,7 +57,7 @@ jobs:
         arch:
           # - x86
           - x64
-          - aarch64
+          # - aarch64
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1

CHANGELOG.md

@@ -9,9 +9,12 @@ Categories: Added, Changed, Deprecated, Removed, Fixed, and Security.
 
 ## [Unreleased]
 
+### Added
+* documentation strings for functions in formulary.jl, output.jl, and behavior.jl
+
 ### Fixed
-* extended documentation strings for some functions
-* loading errors with illstructured path file
+* loading errors with ill-structured path file
+
 
 ## Version [1.0.2] 2022-09-01
 

README.md

@@ -12,7 +12,7 @@ TrainRuns.jl is a step towards open science and open data in railway engineering
 
 # Installation
 
-Use the package manager provided by julia:
+Use the package manager provided by [julia](https://julialang.org):
 ```julia
 julia> # use the ] key
 (@v1.x) pkg> add TrainRuns
@@ -42,6 +42,14 @@ println("The train needs $runtime seconds for the running path.")
 
 ------------
 
+# Further Information
+
+Visit the repository [TrainRuns.jl-Tutorials](https://github.com/railtoolkit/TrainRuns.jl-Tutorials) for tutorials in either Jupyther Notebooks or Pluto Notebooks. There you can find, for instance, a [basic tutorial](https://github.com/railtoolkit/TrainRuns.jl-Tutorials/blob/main/basic.ipynb).
+
+Please refer to the automated [documentation](https://www.railtoolkit.org/TrainRuns.jl/) for technical details of the used functions.
+
+------------
+
 # Acknowledgement
 
 This work was supervised by South Westphalia University of Applied Sciences and Technical University Braunschweig.