From c6c25d2acc16cad65cb5872c30feed2079a8ad10 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Wed, 7 Aug 2024 12:17:58 +0200 Subject: [PATCH] Improve README.md --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ae5ab1a..3a3585b1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,18 @@ This package is part of Julia Kite Power Tools, which consists of the following

## Installation +
+ Installation of Julia + If you do not have Julia installed yet, please read [Installation](https://github.com/aenarete/KiteSimulators.jl/blob/main/docs/Installation.md). + +
+ +
+ Installation as package + +### Installation of KiteControllers as package + It is suggested to use a local Julia environment. You can create it with: ```bash mkdir myproject @@ -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 +
+ +
+ Installation using git + +### 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 @@ -39,6 +57,11 @@ cd bin ./create_sys_image --update cd .. ``` + +
+ +### 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")