Skip to content

Commit d55c046

Browse files
lochelOpenModelica-Hudson
authored andcommitted
Fix some lint warnings for Markdown
Belonging to [master]: - #67
1 parent 094f43a commit d55c046

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# OpenModelica
2+
23
[OpenModelica](https://openmodelica.org) is an open-source Modelica-based modeling and simulation environment intended for industrial and academic usage.
34

45
## Dependencies (Linux/OSX)
56

67
Many software packages are included inside the repositories.
78
To get everything running, you will need a few extras:
9+
810
- C++11 compiler (if you want a GUI)
911
- autoconf, automake, libtool, g++, gfortran (pretty standard compilers)
1012
- boost (optional; used with configure --with-cppruntime)
@@ -25,11 +27,11 @@ To get everything running, you will need a few extras:
2527
## Compilation (Linux/OSX)
2628

2729
```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)
3335
```
3436

3537
## Compilation (Windows)
@@ -39,19 +41,23 @@ Windows instruction are [here](../../../OMCompiler/blob/master/README-OMDev-MING
3941
## Working with the repository
4042

4143
OpenModelica.git is a superproject. Clone the project using one of:
44+
4245
```bash
4346
# Faster pulling by using openmodelica.org read-only mirror (low latency in Europe; very important when updating all submodules)
4447
# Replace the openmodelica.org pull URL with https://github.com/OpenModelica/OpenModelica.git if you want to pull directly from github
4548
# 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)
46-
MY_FORK=MyGitHubUserName ; git clone https://openmodelica.org/git-readonly/OpenModelica.git --recursive && (cd OpenModelica && git remote set-url --push origin git@github.com:$MY_FORK/OpenModelica.git && git submodule foreach --recursive 'git remote set-url --push origin `git config --get remote.origin.url | sed s,^.*/,git@github.com:'$MY_FORK'/,`')
49+
> MY_FORK=MyGitHubUserName ; git clone https://openmodelica.org/git-readonly/OpenModelica.git --recursive && (cd OpenModelica && git remote set-url --push origin git@github.com:$MY_FORK/OpenModelica.git && git submodule foreach --recursive 'git remote set-url --push origin `git config --get remote.origin.url | sed s,^.*/,git@github.com:'$MY_FORK'/,`')
4750
```
51+
4852
If you are a developer and want to track the latest heads, use:
53+
4954
```bash
5055
# After cloning
51-
git submodule foreach --recursive "git checkout master"
56+
> git submodule foreach --recursive "git checkout master"
5257
# 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"
5459
```
60+
5561
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).
5662

5763
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
6167
See [CONTRIBUTING.md](https://github.com/OpenModelica/OpenModelica/blob/master/CONTRIBUTING.md).
6268

6369
### To checkout a minimal version of OpenModelica
70+
6471
```bash
65-
git clone https://openmodelica.org/git-readonly/OpenModelica.git OpenModelica-minimal
66-
cd OpenModelica-minimal
67-
git submodule update --init --recursive libraries testsuite OMCompiler common
72+
> git clone https://openmodelica.org/git-readonly/OpenModelica.git OpenModelica-minimal
73+
> cd OpenModelica-minimal
74+
> git submodule update --init --recursive libraries testsuite OMCompiler common
6875
```
6976

7077
## OpenModelica User's Guide
78+
7179
The [User's Guide](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/)
7280
is automatically generated from the documentation repository.

0 commit comments

Comments
 (0)