You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-11Lines changed: 19 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,12 @@
1
1
# OpenModelica
2
+
2
3
[OpenModelica](https://openmodelica.org) is an open-source Modelica-based modeling and simulation environment intended for industrial and academic usage.
3
4
4
5
## Dependencies (Linux/OSX)
5
6
6
7
Many software packages are included inside the repositories.
7
8
To get everything running, you will need a few extras:
9
+
8
10
- C++11 compiler (if you want a GUI)
9
11
- autoconf, automake, libtool, g++, gfortran (pretty standard compilers)
10
12
- boost (optional; used with configure --with-cppruntime)
@@ -25,11 +27,11 @@ To get everything running, you will need a few extras:
25
27
## Compilation (Linux/OSX)
26
28
27
29
```bash
28
-
$ autoconf
29
-
$ ./configure CC=clang CXX=clang++
30
-
$ make -j8
31
-
$ build/bin/omc --version
32
-
$ (cd testsuite/partest && ./runtests.pl)
30
+
> autoconf
31
+
> ./configure CC=clang CXX=clang++
32
+
> make -j8
33
+
> build/bin/omc --version
34
+
> (cd testsuite/partest && ./runtests.pl)
33
35
```
34
36
35
37
## Compilation (Windows)
@@ -39,19 +41,23 @@ Windows instruction are [here](../../../OMCompiler/blob/master/README-OMDev-MING
39
41
## Working with the repository
40
42
41
43
OpenModelica.git is a superproject. Clone the project using one of:
44
+
42
45
```bash
43
46
# Faster pulling by using openmodelica.org read-only mirror (low latency in Europe; very important when updating all submodules)
44
47
# Replace the openmodelica.org pull URL with https://github.com/OpenModelica/OpenModelica.git if you want to pull directly from github
45
48
# The default choice is to push to your fork on github.com (SSH). Replace MY_FORK with OpenModelica to push directly to the OpenModelica repositories (if you have access)
# To update; you will need to merge each submodule, but your changes will remain
53
-
git submodule foreach --recursive "git pull"
58
+
>git submodule foreach --recursive "git pull"
54
59
```
60
+
55
61
In order to push to the repository, you will push to your own fork of OMCompiler.git, OMEdit.git, etc. You will need to create a fork of each repository that you want to push to (by clicking the Fork button in the GitHub web interface).
56
62
57
63
If you do not checkout the repositories for GUI clients (such as OMEdit.git), these directories will be ignored by autoconf and skipped during compilation.
@@ -61,12 +67,14 @@ If you do not checkout the repositories for GUI clients (such as OMEdit.git), th
61
67
See [CONTRIBUTING.md](https://github.com/OpenModelica/OpenModelica/blob/master/CONTRIBUTING.md).
0 commit comments