Skip to content

Commit 8b151be

Browse files
committed
Update README.md
1 parent a642994 commit 8b151be

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,36 @@ The auto-tuning script shall optimize the controller performance in the time dom
1515
- the types `ParkingController` and `ParkingControllerSettings`
1616
- the functions `linearize`, `calc_steering`, `navigate`
1717

18+
## Installation
19+
<details>
20+
<summary>Installation of Julia</summary>
21+
22+
If you do not have Julia installed yet, please read [Installation](https://github.com/aenarete/KiteSimulators.jl/blob/main/docs/Installation.md).
23+
24+
</details>
25+
26+
<details>
27+
<summary>Installation as package</summary>
28+
29+
### Installation of SimpleKiteControllers as package
30+
31+
It is suggested to use a local Julia environment. You can create it with:
32+
```bash
33+
mkdir myproject
34+
cd myproject
35+
julia --project=.
36+
```
37+
(don't forget typing the dot at the end), and then, on the Julia prompt enter:
38+
```julia
39+
using Pkg
40+
pkg"add https://github.com/OpenSourceAWE/SimpleKiteControllers.jl"
41+
```
42+
You can run the tests with:
43+
```julia
44+
using Pkg
45+
pkg"test SimpleKiteControllers"
46+
```
47+
1848
## TODO
1949
- add examples for using the parking controller
2050
- implement a new path following controller for flying figures of eight, see [Fernandes_2022](https://www.mdpi.com/1996-1073/15/4/1390)

0 commit comments

Comments
 (0)