use readme in python package

hal9ai · May 10, 2024 · 0a0e43f · 0a0e43f
1 parent 466ec4e
commit 0a0e43f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/.github/workflows/python.yaml b/.github/workflows/python.yaml
@@ -14,6 +14,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Copy readme
+        run: cp README.md python/README.md
       - name: Build and publish to pypi
         uses: JRubics/[email protected]
         with:

diff --git a/python/CONTRIBUTING.md b/python/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Python Component
+
+## Contributing
+
+Start by installing the package:
+
+```bash
+pip install poetry
+poetry install
+```
diff --git a/python/README.md b/python/README.md
@@ -1,10 +1 @@
-# Python Component
-
-## Contributing
-
-Start by installing the package:
-
-```bash
-pip install poetry
-poetry install
-```
+See [../README.md](../README.md)
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hal9"
-version = "2.0.1"
+version = "2.0.2"
 description = ""
 authors = ["Javier Luraschi <[email protected]>"]
 readme = "README.md"