Skip to content

Commit 8e060ab

Browse files
committed
Update docu
1 parent fac5cde commit 8e060ab

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/src/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,24 @@ at the Julia prompt. You can run the unit tests with the command (careful, can t
4545
```julia
4646
pkg"test WinchControllers"
4747
```
48+
To add the examples and install the packages needed by the examples, run:
49+
```julia
50+
using WinchControllers
51+
WinchControllers.install_examples()
52+
exit()
53+
```
54+
55+
## Running the examples
56+
To run the examples, launch Julia with:
57+
```bash
58+
julia --project
59+
```
60+
and then, in the Julia REPL, type:
61+
```julia
62+
include("examples/menu.jl")
63+
```
64+
You should now see a terminal menu with some examples. Select one using the
65+
`<CURSOR UP>` and `<CURSOR DOWN>` keys, and press `<ENTER>` to run the selected example.
4866

4967
## Provides
5068
- a set of generic control components, see [Generic Components](@ref)

0 commit comments

Comments
 (0)