Pyboard D now references official docs.

pull/12/head
Peter Hinch 2019-03-26 10:58:03 +00:00
rodzic 063c02d607
commit c982d53787
2 zmienionych plików z 12 dodań i 12 usunięć

Wyświetl plik

@ -4,7 +4,7 @@ Paul Sokolovsky, the author of most of the micropython library and major
contributor to MicroPython, has forked the MicroPython project. This is the contributor to MicroPython, has forked the MicroPython project. This is the
[pycopy fork](https://github.com/pfalcon/pycopy). [pycopy fork](https://github.com/pfalcon/pycopy).
Official firmware may be found [on micropython.org](https://micropython.org/). Official firmware may be found on [micropython.org](https://micropython.org/).
Each firmware build has its own library. Some modules in the Pycopy library are Each firmware build has its own library. Some modules in the Pycopy library are
incompatible with the official firmware. incompatible with the official firmware.
@ -12,9 +12,9 @@ Libraries may be installed by copying files from the appropriate library
repository to the target device. However this requires some attention to detail repository to the target device. However this requires some attention to detail
where there are dependencies or where modules are organised as Python packages. where there are dependencies or where modules are organised as Python packages.
Each fork has means of installing library and user contributed modules modelled Each fork has applications for installing library and user contributed modules
on Python's `pip`. These handle dependencies and build the correct directory modelled on Python's `pip`. These handle dependencies and build the correct
structure on the target. directory structure on the target.
Note that `pip` and `pip3` cannot be used for MicroPython modules. This is Note that `pip` and `pip3` cannot be used for MicroPython modules. This is
because the file format is nonstandard. The file format was chosen to enable because the file format is nonstandard. The file format was chosen to enable
@ -27,8 +27,8 @@ the installer to run on targets with minimal resources.
2. [Users of Pycopy firmware](./README.md#2-users-of-pycopy-firmware) 2. [Users of Pycopy firmware](./README.md#2-users-of-pycopy-firmware)
3. [Users of official MicroPython](./README.md#3-users-of-official-micropython) 3. [Users of official MicroPython](./README.md#3-users-of-official-micropython)
3.1 [The installers](./README.md#31-the-installers) 3.1 [The installers](./README.md#31-the-installers)
3.1.1 [upip_m](./README.md#311-upip_m) 3.1.1 [upip_m](./README.md#311-upip_m) upip replacement runs on target hardware
3.1.2 [micropip](./README.md#312-micropip) 3.1.2 [micropip](./README.md#312-micropip) Runs on a PC
4. [Overriding built in library modules](./README.md#4-overriding-built-in-library-modules) 4. [Overriding built in library modules](./README.md#4-overriding-built-in-library-modules)
###### [Main README](../README.md) ###### [Main README](../README.md)
@ -56,16 +56,16 @@ Usage of `upip` is documented in the
The library at [micropython-lib](https://github.com/micropython/micropython-lib) The library at [micropython-lib](https://github.com/micropython/micropython-lib)
is compatible with the official firmware. Unfortunately for users of official is compatible with the official firmware. Unfortunately for users of official
firmware its README is misleading, not least because the advocated `upip` firmware its README is misleading, not least because the advocated `upip`
module may produce an incorrect result. This is because some library modules on module may produce an incorrect result. This is because it installs from
[PyPi](https://pypi.org/) require the `pycopy` firmware. [PyPi](https://pypi.org/) and some modules there require the `pycopy` firmware.
Two (unofficial) utilities are provided for users of the official firmware. Two (unofficial) utilities are provided for users of the official firmware.
Where a library module is to be installed, these will locate a compatible Where a library module is to be installed, these will locate a compatible
version. User contributed modules located on PyPi will be handled as normal. version. User contributed modules located on PyPi will be handled as normal.
* `upip_m.py` A modified version of `upip.py`. For network enabled targets. * `upip_m.py` A modified version of `upip.py`. For network enabled targets.
* `micropip.py` Installs modules to a PC for copying to the target device. * `micropip.py` Installs modules to a PC for copying to the target device.
For non-networked targets and for targets with too little RAM to run This is primarily for non-networked targets and for targets with insufficient
`upip_m.py`. Requires CPython 3.2 or later. RAM to run `upip_m.py`. Requires CPython 3.2 or later.
## 3.1 The installers ## 3.1 The installers

Wyświetl plik

@ -1,7 +1,7 @@
# Unofficial guide to the Pyboard D # Unofficial guide to the Pyboard D
I'll update this with contributed ideas (issues, PR's and forum comments). I Note: official docs may now be found [here](https://pybd.io/hw/pybd_sfxw.html)
expect to delete it when official docs emerge. so I expect to remove this guide soon.
## LED's ## LED's