From 0d2b3e71a8d68bee3c8efff75e771e00a6332b0c Mon Sep 17 00:00:00 2001
From: arun3688 <rain100falls@gmail.com>
Date: Wed, 8 Nov 2023 11:14:03 +0100
Subject: [PATCH] change to markdown and add status badge

---
 README.md  | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.rst | 69 ------------------------------------------------
 2 files changed, 77 insertions(+), 69 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..90db04187
--- /dev/null
+++ b/README.md
@@ -0,0 +1,77 @@
+# OMPython
+
+OMPython is a Python interface that uses ZeroMQ or CORBA (omniORB) to
+communicate with OpenModelica.
+
+[![FMITest](https://github.com/OpenModelica/OMPython/actions/workflows/FMITest.yml/badge.svg)]
+(https://github.com/OpenModelica/OMPython/actions/workflows/FMITest.yml)
+[![Test](https://github.com/OpenModelica/OMPython/actions/workflows/Test.yml/badge.svg)]
+(https://github.com/OpenModelica/OMPython/actions/workflows/Test.yml)
+
+## Dependencies
+
+### Using ZeroMQ
+
+-   Python 2.7 and 3.x supported
+-   PyZMQ is required
+
+### Using omniORB
+
+-   Currently, only Python 2.7 is supported
+-   omniORB is required:
+    -   Windows: included in the OpenModelica installation
+    -   Linux: Install omniORB including Python 2 support (the omniidl
+        command needs to be on the PATH). On Ubuntu, this is done by
+        running
+        `sudo apt-get install omniorb python-omniorb omniidl omniidl-python`
+
+## Installation
+
+Installation using `pip` is recommended.
+
+### Linux
+
+Install the latest OMPython master by running:
+
+    python -m pip install -U https://github.com/OpenModelica/OMPython/archive/master.zip
+
+### Windows
+
+Install the version as packaged with your OpenModelica installation by
+running:
+
+    cd %OPENMODELICAHOME%\share\omc\scripts\PythonInterface
+    python -m pip install -U .
+
+Instead, to Install the latest version of the OMPython master branch
+only, previously cloned into `<OMPythonPath>`, run:
+
+    cd <OMPythonPath>
+    python -m pip install -U .
+
+## Usage
+
+Running the following commads should get you started
+
+``` python
+import OMPython
+help(OMPython)
+```
+
+or read the [OMPython
+documentation](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/ompython.html)
+online.
+
+## Bug Reports
+
+-   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).
+-   [Pull requests](https://github.com/OpenModelica/OMPython/pulls) are
+    welcome.
+
+## Contact
+
+-   Adeel Asghar, <adeel.asghar@liu.se>
+-   Arunkumar Palanisamy, <arunkumar.palanisamy@liu.se>
\ No newline at end of file
diff --git a/README.rst b/README.rst
deleted file mode 100644
index c13afdaab..000000000
--- a/README.rst
+++ /dev/null
@@ -1,69 +0,0 @@
-########
-OMPython
-########
-
-OMPython is a Python interface that uses ZeroMQ or CORBA (omniORB) to communicate with OpenModelica.
-
-Dependencies
-============
-
-Using ZeroMQ
-------------
-- Python 2.7 and 3.x supported
-- PyZMQ is required
-
-Using omniORB
--------------
-- Currently, only Python 2.7 is supported
-- omniORB is required:
-
-  - Windows: included in the OpenModelica installation
-  - Linux: Install omniORB including Python 2 support (the omniidl command needs to be on the PATH).
-    On Ubuntu, this is done by running ``sudo apt-get install omniorb python-omniorb omniidl omniidl-python``
-
-
-Installation
-============
-Installation using ``pip`` is recommended.
-
-Linux
------
-Install the latest OMPython master by running::
-
-  python -m pip install -U https://github.com/OpenModelica/OMPython/archive/master.zip
-
-Windows
--------
-Install the version as packaged with your OpenModelica installation by running::
-
-  cd %OPENMODELICAHOME%\share\omc\scripts\PythonInterface
-  python -m pip install -U .
-
-Instead, to Install the latest version of the OMPython master branch only, previously cloned into ``<OMPythonPath>``, run::
-
-  cd <OMPythonPath>
-  python -m pip install -U .
-
-Usage
-=====
-Running the following commads should get you started
-
-.. code-block:: python
-
-  import OMPython
-  help(OMPython)
-
-or read the `OMPython documentation <https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/ompython.html>`_ online.
-
-Bug Reports
-===========
-
-- 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>`_.
-- `Pull requests <https://github.com/OpenModelica/OMPython/pulls>`_ are welcome.
-
-Contact
-=======
-
-- Adeel Asghar, adeel.asghar@liu.se
-- Arunkumar Palanisamy, arunkumar.palanisamy@liu.se