Add README and package description to pip package (#875)

OpenModelica · Nov 16, 2020 · 3135d7a · 3135d7a
1 parent 5ea5bd8
commit 3135d7a
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 13 deletions.
diff --git a/src/pip/CMakeLists.txt b/src/pip/CMakeLists.txt
@@ -3,5 +3,5 @@ project(pip)
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/setup.py" "${CMAKE_CURRENT_BINARY_DIR}/setup.py" @ONLY)
 
 install(FILES "${CMAKE_CURRENT_BINARY_DIR}/setup.py" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
-install(FILES "${CMAKE_SOURCE_DIR}/README.md" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
+install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/README.md" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
 install(FILES "${CMAKE_SOURCE_DIR}/OSMC-License.txt" DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/install/)
diff --git a/src/pip/README.md b/src/pip/README.md
@@ -0,0 +1,3 @@
+# OMSimulator [![License: OSMC-PL](https://img.shields.io/badge/license-OSMC--PL-lightgrey.svg)](OSMC-License.txt)
+
+The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
diff --git a/src/pip/setup.py b/src/pip/setup.py
@@ -119,15 +119,21 @@ def run(self):
       self.fetch_oms()
     build_py.run(self)
 
-setup(name = 'OMSimulator',
-      version = '@OMS_SHORT_VERSION_STRING@',
-      description = 'OMSimulator - the FMI-based co-simulation environment for Python',
-      author = 'Open Source Modelica Consortium (OSMC)',
-      author_email = 'openmodelicadevelopers@ida.liu.se',
-      license = "BSD, OSMC-PL 1.2, GPL (user's choice)",
-      url = 'http://openmodelica.org/',
-      install_requires = ['requests'],
-      packages = ['OMSimulator'],
-      cmdclass = {'build_py': my_build_py},
-      zip_safe = False
-      )
+with open('README.md', 'r') as fh:
+  long_description = fh.read()
+
+setup(
+  name = 'OMSimulator',
+  version = '@OMS_SHORT_VERSION_STRING@',
+  description = 'OMSimulator - the FMI-based co-simulation environment for Python',
+  long_description = long_description,
+  long_description_content_type = 'text/markdown',
+  author = 'Open Source Modelica Consortium (OSMC)',
+  author_email = 'openmodelicadevelopers@ida.liu.se',
+  license = "BSD, OSMC-PL 1.2, GPL (user's choice)",
+  url = 'http://openmodelica.org/',
+  install_requires = ['requests'],
+  packages = ['OMSimulator'],
+  cmdclass = {'build_py': my_build_py},
+  zip_safe = False
+)