Skip to content

Commit 30fc1e0

Browse files
committed
Document mip installation.
1 parent da50a59 commit 30fc1e0

File tree

3 files changed

+26
-8
lines changed

3 files changed

+26
-8
lines changed

v3/docs/DRIVERS.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,14 @@ goes outside defined bounds.
4242

4343
# 2. Installation and usage
4444

45-
The drivers require firmware version >=1.15. The drivers are in the primitives
46-
package. To install copy the `primitives` directory and its contents to the
47-
target hardware.
45+
The latest release build of firmware or a newer nightly build is recommended.
46+
To install the library, connect the target hardware to WiFi and issue:
47+
```python
48+
import mip
49+
mip.install("github:peterhinch/micropython-async/v3/primitives")
50+
```
51+
For non-networked targets use `mpremote` as described in
52+
[the official docs](http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote).
4853

4954
Drivers are imported with:
5055
```python

v3/docs/THREADING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ the `ThreadSafeFlag` class does not work under the Unix build. The classes
1616
presented here depend on this: none can be expected to work on Unix until this
1717
is fixed.
1818

19+
To install the threadsafe classes discussed here, connect the target hardware
20+
to WiFi and issue:
21+
```python
22+
import mip
23+
mip.install("github:peterhinch/micropython-async/v3/threadsafe")
24+
```
25+
For non-networked targets use `mpremote` as described in
26+
[the official docs](http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote).
27+
1928
###### [Main README](../README.md)
2029
###### [Tutorial](./TUTORIAL.md)
2130

v3/docs/TUTORIAL.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,16 @@ CPython V3.8 and above.
118118

119119
## 0.1 Installing uasyncio
120120

121-
Firmware builds after V1.13 incorporate `uasyncio`. Check the firmware version
122-
number reported on boot and upgrade if necessary.
123-
121+
The latest release build of firmware or a newer nightly build is recommended.
124122
This repository has optional unofficial primitives and extensions. To install
125-
these the repo should be cloned to a PC. The directories `primitives` and
126-
`threadsafe` (with contents) should be copied to the hardware plaform.
123+
these, connect the target hardware to WiFi and issue:
124+
```python
125+
import mip
126+
mip.install("github:peterhinch/micropython-async/v3/primitives")
127+
mip.install("github:peterhinch/micropython-async/v3/threadsafe")
128+
```
129+
For non-networked targets use `mpremote` as described in
130+
[the official docs](http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote).
127131

128132
###### [Main README](../README.md)
129133

0 commit comments

Comments
 (0)