Skip to content

Commit 09d7b7a

Browse files
committed
README.md file improved
1 parent 6f3d771 commit 09d7b7a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,23 @@ Component models are defined by `@model` macros. Such models contain definition
2121

2222
## Installation
2323

24-
The package is registered in METADATA.jl. Once the registration process of
25-
ModiaMath 0.2.4 is finalized, a new release of Modia will be registered
26-
and Modia can be installed with Pkg.add.
24+
**Modia** is registered in METADATA.jl and can be installed with Pkg.add:
2725

2826
```julia
29-
# Julia 0.6, 0.7, 1.0:
27+
# Julia 0.6:
3028
julia> Pkg.add("Modia")
3129

32-
# alternatively in Julia 0.7 and 1.0:
30+
# Julia 0.7 and 1.0:
3331
julia> ]add Modia
3432
```
3533

3634
Modia uses [PyPlot](https://github.com/JuliaPy/PyPlot.jl) for plotting.
3735
If `PyPlot` is not available in your current Julia environment
3836
an information message is printed and all `plot(..)` calls are ignored.
37+
3938
In order that plot windows are displayed, you need to add `PyPlot` to your current environment
4039
via `]add PyPlot`. Often this automatic installation fails and it is recommended to follow
41-
instead the instructions
40+
the instructions
4241
[Installing PyPlot in a robust way](https://github.com/ModiaSim/ModiaMath.jl/wiki/Installing-PyPlot-in-a-robust-way).
4342

4443

@@ -66,6 +65,9 @@ instead the instructions
6665
```
6766

6867
## Examples
68+
69+
The schematics below are screenshots of [Modelica models](https://www.modelica.org/). These models have been converted to Modia and the examples below execute these models. Note, in Modia there is not (yet) a graphical definition of models.
70+
6971
### Current Controller
7072
![Current Controller](https://github.com/ModiaSim/Modia.jl/blob/master/docs/CurrentController.png "Multi-domain model: Current Controller")
7173

0 commit comments

Comments
 (0)