Add description to setup.py to fix #125 (#126)

* Add description to setup.py to fix #125 * Add trivial README.md
OpenVoiceOS · Jul 20, 2023 · 7606662 · 7606662
1 parent e6465ba
commit 7606662
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# OVOS Workshop
+OVOS Workshop contains skill base classes and supporting tools to build skills
+and applications for OpenVoiceOS systems.
diff --git a/setup.py b/setup.py
@@ -49,6 +49,12 @@ def required(requirements_file):
                 if pkg.strip() and not pkg.startswith("#")]
 
 
+def get_description():
+    with open(os.path.join(BASEDIR, "README.md"), "r") as f:
+        long_description = f.read()
+    return long_description
+
+
 setup(
     name='ovos_workshop',
     version=get_version(),
@@ -67,6 +73,8 @@ def required(requirements_file):
     author_email='[email protected]',
     include_package_data=True,
     description='frameworks, templates and patches for the OpenVoiceOS universe',
+    long_description=get_description(),
+    long_description_content_type="text/markdown",
     entry_points={
         'console_scripts': [
             'ovos-skill-launcher=ovos_workshop.skill_launcher:_launch_script'