Document installation with mip and mpremote (#4)

We document how the users can install the package. We haven't tested it yet.
aas-core-works · Apr 10, 2024 · 940c722 · 940c722
1 parent 415c0d4
commit 940c722
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -26,3 +26,18 @@ Due to the limitations we had to **exclude**:
 Versioning
 ==========
 We follow the versioning of the original SDK that we patched.
+
+Installation
+============
+We provide a [package.json](package.json), so you can directly install using `mpremote` from this repository:
+
+.. code-block::
+
+   mpremote mip install github:aas-core-works/aas-core3.0-micropython
+
+... or using `mip`:
+
+.. code-block::
+
+   micropython -m mip install github:aas-core-works/aas-core3.0-micropython
+