Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ufechner7 committed Aug 7, 2024
1 parent d7ae54f commit c6c25d2
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ This package is part of Julia Kite Power Tools, which consists of the following
<p align="center"><img src="./docs/kite_power_tools.png" width="500" /></p>

## Installation
<details>
<summary>Installation of Julia</summary>

If you do not have Julia installed yet, please read [Installation](https://github.com/aenarete/KiteSimulators.jl/blob/main/docs/Installation.md).

</details>

<details>
<summary>Installation as package</summary>

### Installation of KiteControllers as package

It is suggested to use a local Julia environment. You can create it with:
```bash
mkdir myproject
Expand All @@ -25,7 +36,14 @@ You can run the tests with:
using Pkg
pkg"test KiteControllers"
```
But in most cases -- if you want to modify, tune and understand kite controllers -- it is better
</details>

<details>
<summary>Installation using git</summary>

### Installation of KiteControllers using git

In most cases -- if you want to modify, tune and understand kite controllers -- it is better
to check out this project from git. You can do this with:
```bash
git clone https://github.com/aenarete/KiteControllers.jl.git
Expand All @@ -39,6 +57,11 @@ cd bin
./create_sys_image --update
cd ..
```

</details>

### Running the first example

You can now start Julia with `./bin/run_julia` and execute the autopilot or any other of the examples with:
```julia
include("example/autopilot.jl")
Expand Down

0 comments on commit c6c25d2

Please sign in to comment.