Add PyPi README for qc_framework

asam-ev · Oct 8, 2024 · 4fe650f · 4fe650f
1 parent 9d74009
commit 4fe650f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/qc_framework/README.md b/qc_framework/README.md
@@ -0,0 +1,5 @@
+# asam-qc-framework
+
+This is the Python package for the ASAM Quality Checker Framework.
+
+Visit the [main GitHub repository](https://github.com/asam-ev/qc-framework) for detailed documentation.
diff --git a/qc_framework/pyproject.toml b/qc_framework/pyproject.toml
@@ -4,7 +4,7 @@ version = "1.0.0rc1"
 description = "Python ASAM Quality Checker Framework module. Executes bundles and creates result reports."
 authors = ["Danilo Romano <[email protected]>","Patrick Abrahão <[email protected]>","Tung Dinh <[email protected]>"]
 license = "MPL-2.0"
-readme = "../doc/manual/python_qc_framework.md"
+readme = "README.md"
 packages = [
     { include = "qc_framework" },
 ]