From c5e7c6b82b51c1452a5bc35ba10555f070ca1ccb Mon Sep 17 00:00:00 2001 From: peterhinch Date: Tue, 1 Nov 2022 09:21:49 +0000 Subject: [PATCH] Update instructions on installing library modules. --- micropip/README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/micropip/README.md b/micropip/README.md index c859404..eb3297e 100644 --- a/micropip/README.md +++ b/micropip/README.md @@ -6,27 +6,10 @@ # 1. Installing MicroPython library modules -There are various forks of MicroPython, consequently libraries on -[PyPi](https://pypi.org/) may or may not be compatible with official firmware. -This is resolved by official `upip` (and its `micropip` derivative). These -first search the official library. Only if no match is found do they install -from PyPi. For this and other reasons, `pip` and `pip3` should not be used to -install MicroPython libraries. Use of `upip` is detailed in the -[official docs](http://docs.micropython.org/en/latest/reference/packages.html). - -Users of non-networked hardware such as the Pyboard 1.x can use `upip` with the -Unix build of MicroPython to install a library module to an arbitrary directory -on a PC, from where the files and directories can be copied to the target -hardware. `upip` and its dependency `upip_utarfile` may be found in the `tools` -directory of the source tree. This approach has the drawback of requiring the -Unix build, which must be built from source. This may be avoided by using -`micropip.py` in this repo which runs under CPython. - -Alternatively libraries may be installed by copying files from the MicroPython -[library repository](https://github.com/micropython/micropython-lib) to the -target device. However this requires some attention to detail where there are -dependencies. Where modules are organised as Python packages the directory -structure must be maintained. +MicroPython no longer uses PyPi for official software, so `upip` and `micropip` +are largely obsolete. Please read +[the official docs](http://docs.micropython.org/en/latest/reference/packages.html#packages) +for up to date instructions on installing official library modules. ## 1.1 Installing unofficial packages