Skip to content

Commit 4e2bbe4

Browse files
committed
Update documentation about installing with mip
Add documentation for installing with `mip`. Keep the instructions for installing using `upip` for now, as we still intend to publish to PyPI for now, and thereby keep supporting installing on older MicroPython versions, which do not yet have `mip`.
1 parent b284091 commit 4e2bbe4

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,13 @@ To get going run the following directly on the ESP32:
6262

6363
.. code-block:: python
6464
65-
# Step 1: Install micropython-esp32-ulp
6665
# IMPORTANT: Ensure the ESP32 is connected to a network with internet connectivity.
66+
67+
# Step 1: Install micropython-esp32-ulp (for MicroPython v1.20 or newer)
68+
import mip
69+
mip.install('github:micropython/micropython-esp32-ulp')
70+
71+
# Step 1: Install micropython-esp32-ulp (for MicroPython older than v1.20)
6772
import upip
6873
upip.install('micropython-esp32-ulp')
6974

docs/index.rst

+8-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,17 @@ Overview
1313
Installation
1414
------------
1515

16-
On the ESP32, install using upip:
16+
On the ESP32, install using mip (or upip on older MicroPythons):
1717

1818
.. code-block:: python
1919
20-
# ensure the ESP32 is connected to a network with internet connectivity
20+
# step 1: ensure the ESP32 is connected to a network with internet connectivity
21+
22+
# step 2 (for MicroPython 1.20 or newer)
23+
import mip
24+
mip.install('github:micropython/micropython-esp32-ulp')
25+
26+
# step 2 (for MicroPython older than 1.20)
2127
import upip
2228
upip.install('micropython-esp32-ulp')
2329

0 commit comments

Comments
 (0)