max
/
TrainRun.jl
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated README.md with tutorials and documentation

master
Martin Scheidt 2022-12-21 15:43:23 +01:00
parent 77db3c616a
commit fcf6a16b82
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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.