Skip to content

Commit f0ed97a

Browse files
committed
README: Mention that some modules may require pfalcon's fork.
1 parent 9ff3bea commit f0ed97a

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
micropython-lib
22
===============
33
micropython-lib is a project to develop a non-monolothic standard library
4-
for MicroPython (https://github.com/micropython/micropython). Each module
5-
or package is available as a separate distribution package from PyPI. Each
6-
module comes from one of the following sources (and thus each module has
7-
its own licensing terms):
4+
for "advanced" MicroPython fork (https://github.com/pfalcon/micropython).
5+
Each module or package is available as a separate distribution package from
6+
PyPI. Each module comes from one of the following sources (and thus each
7+
module has its own licensing terms):
88

99
* written from scratch specifically for MicroPython
1010
* ported from CPython
1111
* ported from some other Python implementation, e.g. PyPy
1212
* some modules actually aren't implemented yet and are dummy
1313

14-
Note that the main target of micropython-lib is a "Unix" port of MicroPython.
15-
Actual system requirements vary per module. For example, if a module is not
16-
related to I/O, it may work without problems on bare-metal ports too (e.g.
17-
pyboard).
14+
Note that the main target of micropython-lib is a "Unix" port of the
15+
aforementioned fork of MicroPython. Actual system requirements vary per
16+
module. Majority of modules are compatible with the upstream MicroPython,
17+
though some may require additional functionality/optimizations present in
18+
the "advanced" fork. Modules not related to I/O may also work without
19+
problems on bare-metal ports, not just on "Unix" port (e.g. pyboard).
1820

1921

2022
Usage

0 commit comments

Comments
 (0)