summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-02-26 21:51:01 +0200
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-02-26 21:51:25 +0200
commitd155fecf9e27617d23a2249dacdbbcc203bdd85e (patch)
treee45f0860bfd1ea99ec24369f4c290a33a27f6e81
parent12d6d777e1d4bfc08e25def72cc8783ad2e6cd14 (diff)
downloadmicropython-d155fecf9e27617d23a2249dacdbbcc203bdd85e.tar.gz
micropython-d155fecf9e27617d23a2249dacdbbcc203bdd85e.zip
README.md: Update subdir descriptions.
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index af9bb6f1a4..1eec212575 100644
--- a/README.md
+++ b/README.md
@@ -25,20 +25,24 @@ See the repository www.github.com/micropython/pyboard for the Micro
Python board, the officially supported reference electronic circuit board.
Major components in this repository:
-- py/ -- the core Python implementation, including compiler and runtime.
+- py/ -- the core Python implementation, including compiler, runtime, and
+ core library.
- unix/ -- a version of Micro Python that runs on Unix.
- stmhal/ -- a version of Micro Python that runs on the Micro Python board
with an STM32F405RG (using ST's Cube HAL drivers).
-- teensy/ -- a version of Micro Python that runs on the Teensy 3.1
- (preliminary but functional).
+- minimal/ -- a minimal Micro Python port. Start with this if you want
+ to port Micro Python to another microcontroller.
Additional components:
-- bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Start
- with this if you want to port Micro Python to another microcontroller.
+- bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Used
+ mostly to control code size.
+- teensy/ -- a version of Micro Python that runs on the Teensy 3.1
+ (preliminary but functional).
- unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
- tests/ -- test framework and test scripts.
- tools/ -- various tools, including the pyboard.py module.
- examples/ -- a few example Python scripts.
+- docs/ -- official documentation in RST format.
"make" is used to build the components, or "gmake" on BSD-based systems.
You will also need bash and Python (at least 2.7 or 3.3).