README: Mention that some modules may require pfalcon's fork.

pull/246/merge
Paul Sokolovsky 2018-01-07 16:04:59 +02:00
rodzic 9ff3beabd1
commit f0ed97ad23
1 zmienionych plików z 10 dodań i 8 usunięć

Wyświetl plik

@ -1,20 +1,22 @@
micropython-lib micropython-lib
=============== ===============
micropython-lib is a project to develop a non-monolothic standard library micropython-lib is a project to develop a non-monolothic standard library
for MicroPython (https://github.com/micropython/micropython). Each module for "advanced" MicroPython fork (https://github.com/pfalcon/micropython).
or package is available as a separate distribution package from PyPI. Each Each module or package is available as a separate distribution package from
module comes from one of the following sources (and thus each module has PyPI. Each module comes from one of the following sources (and thus each
its own licensing terms): module has its own licensing terms):
* written from scratch specifically for MicroPython * written from scratch specifically for MicroPython
* ported from CPython * ported from CPython
* ported from some other Python implementation, e.g. PyPy * ported from some other Python implementation, e.g. PyPy
* some modules actually aren't implemented yet and are dummy * some modules actually aren't implemented yet and are dummy
Note that the main target of micropython-lib is a "Unix" port of MicroPython. Note that the main target of micropython-lib is a "Unix" port of the
Actual system requirements vary per module. For example, if a module is not aforementioned fork of MicroPython. Actual system requirements vary per
related to I/O, it may work without problems on bare-metal ports too (e.g. module. Majority of modules are compatible with the upstream MicroPython,
pyboard). though some may require additional functionality/optimizations present in
the "advanced" fork. Modules not related to I/O may also work without
problems on bare-metal ports, not just on "Unix" port (e.g. pyboard).
Usage Usage