summaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-29 00:02:31 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-29 00:02:31 +0300
commitc10d303e1b61aba3c1cb16b4bd7df167b0c7eeb3 (patch)
treed694c856b507eb4a3869d0b79706634273ccb85a /README.md
parentaf554b4ba2d0b6b1a4900918c720c565d3174ab7 (diff)
downloadmicropython-c10d303e1b61aba3c1cb16b4bd7df167b0c7eeb3.tar.gz
micropython-c10d303e1b61aba3c1cb16b4bd7df167b0c7eeb3.zip
README: Promote "docs" and "tests" to "major components".
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1bfe2434a3..72a481ca02 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,8 @@ Major components in this repository:
with an STM32F405RG (using ST's Cube HAL drivers).
- minimal/ -- a minimal MicroPython port. Start with this if you want
to port MicroPython to another microcontroller.
+- tests/ -- test framework and test scripts.
+- docs/ -- user documentation in Sphinx reStructuredText format.
Additional components:
- bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used
@@ -48,10 +50,8 @@ Additional components:
- pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
- cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
- esp8266/ -- an experimental port for ESP8266 WiFi modules.
-- 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).