Skip to content

Commit cb0c507

Browse files
authored
Update README.md
1 parent 29fc864 commit cb0c507

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,28 @@
2121
[deps-img]: https://juliahub.com/docs/General/CTBase/stable/deps.svg
2222
[deps-url]: https://juliahub.com/ui/Packages/General/CTBase?t=2
2323

24+
[licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg
25+
[licence-url]: https://github.com/control-toolbox/CTBase.jl/blob/master/LICENSE
26+
2427
The CTBase.jl package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
25-
The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) which aims to provide tools to modelise and solve optimal control problems by direct and indirect methods. [![doc OptimalControl.jl](https://img.shields.io/badge/doc-OptimalControl.jl-blue)](http://control-toolbox.org/OptimalControl.jl)
28+
The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) which aims to provide tools to modelise and solve optimal control problems with ordinary differential equations by direct and indirect methods.
29+
30+
[![doc OptimalControl.jl](https://img.shields.io/badge/Documentation-OptimalControl.jl-blue)](http://control-toolbox.org/OptimalControl.jl)
2631

27-
| **Documentation** | **Code Status** | **Release** |
28-
|:-------------------|:-----------------|:-------------|
29-
| [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url] | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![pkgeval][pkg-eval-img]][pkg-eval-url] [![deps][deps-img]][deps-url] | [![version][release-img]][release-url] |
32+
| **Name** | **Badge** |
33+
:-------------------|:------------------|
34+
| Documentation | [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url] |
35+
| Code Status | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![pkgeval][pkg-eval-img]][pkg-eval-url] |
36+
| Licence | [![License: MIT][licence-img]][licence-url] |
37+
| Release | [![Release][release-img]][release-url] |
3038

3139
## Installation
3240

33-
To install a package from the control-toolbox ecosystem, please visit the [installation page](https://github.com/control-toolbox#installation).
41+
To install CTBase.jl please
42+
<a href="https://docs.julialang.org/en/v1/manual/getting-started/">open Julia's interactive session (known as REPL)</a>
43+
and press <kbd>]</kbd> key in the REPL to use the package mode, then add the package:
44+
45+
```julia
46+
julia> ]
47+
pkg> add CTBase
48+
```

0 commit comments

Comments
 (0)