Skip to content

Commit

Permalink
Update documentation about installing with mip
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
wnienhaus committed Sep 4, 2023
1 parent b284091 commit 4e2bbe4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
7 changes: 6 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,13 @@ To get going run the following directly on the ESP32:

.. code-block:: python
# Step 1: Install micropython-esp32-ulp
# IMPORTANT: Ensure the ESP32 is connected to a network with internet connectivity.
# Step 1: Install micropython-esp32-ulp (for MicroPython v1.20 or newer)
import mip
mip.install('github:micropython/micropython-esp32-ulp')
# Step 1: Install micropython-esp32-ulp (for MicroPython older than v1.20)
import upip
upip.install('micropython-esp32-ulp')
Expand Down
10 changes: 8 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,17 @@ Overview
Installation
------------

On the ESP32, install using upip:
On the ESP32, install using mip (or upip on older MicroPythons):

.. code-block:: python
# ensure the ESP32 is connected to a network with internet connectivity
# step 1: ensure the ESP32 is connected to a network with internet connectivity
# step 2 (for MicroPython 1.20 or newer)
import mip
mip.install('github:micropython/micropython-esp32-ulp')
# step 2 (for MicroPython older than 1.20)
import upip
upip.install('micropython-esp32-ulp')
Expand Down

0 comments on commit 4e2bbe4

Please sign in to comment.