Skip to content

Commit d155fec

Browse files
committed
README.md: Update subdir descriptions.
1 parent 12d6d77 commit d155fec

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,24 @@ See the repository www.github.com/micropython/pyboard for the Micro
2525
Python board, the officially supported reference electronic circuit board.
2626

2727
Major components in this repository:
28-
- py/ -- the core Python implementation, including compiler and runtime.
28+
- py/ -- the core Python implementation, including compiler, runtime, and
29+
core library.
2930
- unix/ -- a version of Micro Python that runs on Unix.
3031
- stmhal/ -- a version of Micro Python that runs on the Micro Python board
3132
with an STM32F405RG (using ST's Cube HAL drivers).
32-
- teensy/ -- a version of Micro Python that runs on the Teensy 3.1
33-
(preliminary but functional).
33+
- minimal/ -- a minimal Micro Python port. Start with this if you want
34+
to port Micro Python to another microcontroller.
3435

3536
Additional components:
36-
- bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Start
37-
with this if you want to port Micro Python to another microcontroller.
37+
- bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Used
38+
mostly to control code size.
39+
- teensy/ -- a version of Micro Python that runs on the Teensy 3.1
40+
(preliminary but functional).
3841
- unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
3942
- tests/ -- test framework and test scripts.
4043
- tools/ -- various tools, including the pyboard.py module.
4144
- examples/ -- a few example Python scripts.
45+
- docs/ -- official documentation in RST format.
4246

4347
"make" is used to build the components, or "gmake" on BSD-based systems.
4448
You will also need bash and Python (at least 2.7 or 3.3).

0 commit comments

Comments
 (0)