From 4e2bbe43565fd411fca6d29f00a4fe29fc7e930e Mon Sep 17 00:00:00 2001 From: Wilko Nienhaus Date: Mon, 4 Sep 2023 22:26:16 +0300 Subject: [PATCH] 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`. --- README.rst | 7 ++++++- docs/index.rst | 10 ++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 20ddee1..6b650fa 100644 --- a/README.rst +++ b/README.rst @@ -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') diff --git a/docs/index.rst b/docs/index.rst index e9ae38d..b50e01d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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')