@@ -34,24 +34,24 @@ Major components in this repository:
3434 core library.
3535- mpy-cross/ -- the MicroPython cross-compiler which is used to turn scripts
3636 into precompiled bytecode.
37- - unix/ -- a version of MicroPython that runs on Unix.
38- - stmhal / -- a version of MicroPython that runs on the PyBoard and similar
37+ - ports/ unix/ -- a version of MicroPython that runs on Unix.
38+ - ports/stm32 / -- a version of MicroPython that runs on the PyBoard and similar
3939 STM32 boards (using ST's Cube HAL drivers).
40- - minimal/ -- a minimal MicroPython port. Start with this if you want
40+ - ports/ minimal/ -- a minimal MicroPython port. Start with this if you want
4141 to port MicroPython to another microcontroller.
4242- tests/ -- test framework and test scripts.
4343- docs/ -- user documentation in Sphinx reStructuredText format. Rendered
4444 HTML documentation is available at http://docs.micropython.org (be sure
4545 to select needed board/port at the bottom left corner).
4646
4747Additional components:
48- - bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used
48+ - ports/ bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used
4949 mostly to control code size.
50- - teensy/ -- a version of MicroPython that runs on the Teensy 3.1
50+ - ports/ teensy/ -- a version of MicroPython that runs on the Teensy 3.1
5151 (preliminary but functional).
52- - pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
53- - cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
54- - esp8266/ -- an experimental port for ESP8266 WiFi modules.
52+ - ports/ pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
53+ - ports/ cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
54+ - ports/ esp8266/ -- an experimental port for ESP8266 WiFi modules.
5555- extmod/ -- additional (non-core) modules implemented in C.
5656- tools/ -- various tools, including the pyboard.py module.
5757- examples/ -- a few example Python scripts.
@@ -72,7 +72,7 @@ Alternatively, fallback implementation based on setjmp/longjmp can be used.
7272
7373To build (see section below for required dependencies):
7474
75- $ cd unix
75+ $ cd ports/ unix
7676 $ make axtls
7777 $ make
7878
@@ -115,33 +115,33 @@ these additional dependencies, first fetch git submodules for them:
115115 $ git submodule update --init
116116
117117Use this same command to get the latest versions of dependencies, as
118- they are updated from time to time. After that, in ` unix/ ` dir, execute:
118+ they are updated from time to time. After that, in ` ports/ unix/` dir, execute:
119119
120120 $ make deplibs
121121
122122This will build all available dependencies (regardless whether they
123123are used or not). If you intend to build MicroPython with additional
124124options (like cross-compiling), the same set of options should be passed
125125to ` make deplibs ` . To actually enabled use of dependencies, edit
126- ` unix/mpconfigport.mk ` file, which has inline descriptions of the options.
126+ ` ports/ unix/mpconfigport.mk` file, which has inline descriptions of the options.
127127For example, to build SSL module (required for ` upip ` tool described above),
128128set ` MICROPY_PY_USSL ` to 1.
129129
130- In ` unix/mpconfigport.mk ` , you can also disable some dependencies enabled
130+ In ` ports/ unix/mpconfigport.mk` , you can also disable some dependencies enabled
131131by default, like FFI support, which requires libffi development files to
132132be installed.
133133
134- The STM version
135- ---------------
134+ The STM32 version
135+ -----------------
136136
137- The "stmhal " port requires an ARM compiler, arm-none-eabi-gcc, and associated
137+ The "stm32 " port requires an ARM compiler, arm-none-eabi-gcc, and associated
138138bin-utils. For those using Arch Linux, you need arm-none-eabi-binutils and
139139arm-none-eabi-gcc packages. Otherwise, try here:
140140https://launchpad.net/gcc-arm-embedded
141141
142142To build:
143143
144- $ cd stmhal
144+ $ cd ports/stm32
145145 $ make
146146
147147You then need to get your board into DFU mode. On the pyboard, connect the
@@ -155,4 +155,4 @@ Then to flash the code via USB DFU to your device:
155155This will use the included ` tools/pydfu.py ` script. If flashing the firmware
156156does not work it may be because you don't have the correct permissions, and
157157need to use ` sudo make deploy ` .
158- See the README.md file in the stmhal / directory for further details.
158+ See the README.md file in the ports/stm32 / directory for further details.
0 commit comments