Skip to content

Commit 0991e55

Browse files
thoradesjoelund
authored andcommitted
convert markdown syntax to reStructuredText
sections: https://docs.python.org/devguide/documenting.html#sections
1 parent e306b79 commit 0991e55

1 file changed

Lines changed: 25 additions & 10 deletions

File tree

README.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,42 @@
1-
# OMPython
1+
########
2+
OMPython
3+
########
24

35
OMPython is a Python interface that uses CORBA (omniORB) or ZeroMQ to communicate with OpenModelica.
46

5-
## Dependencies
7+
Dependencies
8+
============
9+
10+
Using omniORB (Python 2 only)
11+
-----------------------------
612

7-
### Using omniORB (Python 2 only)
813
- Python 2.7 is required (omniORB restriction). Download Python from http://www.python.org/download/
914
- omniORB is required
1015
- Windows: included in the installer of OpenModelica
1116
- Linux: Install omniORB including Python 2 support (the omniidl command needs to be on the PATH)
1217
On Ubuntu, this is done by running `sudo apt-get install omniorb python-omniorb omniidl omniidl-python`
1318
- Installation using `pip` is recommended.
1419

15-
### Using ZeroMQ (Python 2 and 3 supported)
20+
Using ZeroMQ (Python 2 and 3 supported)
21+
---------------------------------------
22+
1623
- Python 2.7 or 3.x.x is required. Download Python from http://www.python.org/download/
1724
- PyZMQ is required.
1825
- Installation using `pip` is recommended.
1926

20-
## Installation
27+
Installation
28+
============
29+
30+
Linux
31+
-----
2132

22-
### Linux
2333
```bash
2434
$ python -m pip install https://github.com/OpenModelica/OMPython/archive/master.zip
2535
```
2636

27-
### Windows
37+
Windows
38+
-------
39+
2840
- Add python to your PATH.
2941
- Start command prompt/terminal and execute commands,
3042
```powershell
@@ -33,19 +45,22 @@ $ python -m pip install https://github.com/OpenModelica/OMPython/archive/master.
3345
```
3446
- This will add OMPython to the Python 3rd party libraries.
3547

36-
## Usage
48+
Usage
49+
=====
3750

3851
```python
3952
import OMPython
4053
help(OMPython)
4154
```
4255

43-
## Bug Reports
56+
Bug Reports
57+
===========
4458

4559
- See OMPython bugs on the [OpenModelica trac](https://trac.openmodelica.org/OpenModelica/query?component=OMPython) or submit a [new ticket](https://trac.openmodelica.org/OpenModelica/newticket).
4660
- [Pull requests](../../pulls) are welcome.
4761

48-
## Contact
62+
Contact
63+
=======
4964

5065
Adeel Asghar, adeel.asghar@liu.se<br />
5166
Arunkumar Palanisamy, arunkumar.palanisamy@liu.se

0 commit comments

Comments
 (0)