Skip to content

Commit b4c688e

Browse files
committed
Add basic instructions to README.
1 parent f0d0940 commit b4c688e

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
This is the Micro Python project
1+
The Micro Python project
2+
========================
3+
4+
Subdirectories:
5+
- py/ -- the core Python implementation, including compiler and runtime.
6+
- unix/ -- a version of Micro Python that runs on Unix.
7+
- stm/ -- a version of Micro Python that runs on the Micro Python board
8+
with an STM32F405RG.
9+
10+
"make" is used to build the components.
11+
12+
The unix version
13+
----------------
14+
15+
The "unix" part requires a standard Unix environment with gcc. It works
16+
only for 64-bit machines due to a small piece of x86-64 assembler for
17+
the exception handling.
18+
19+
To build:
20+
$ cd unix
21+
$ make
22+
23+
Then to test it:
24+
$ ./py
25+
>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])
26+
27+
The stm version
28+
---------------
29+
30+
The "stm" part requires an ARM compiler, arm-none-eabi-gcc, and associated
31+
bin-utils. For those using Arch Linux, you need arm-none-eabi-binutils and
32+
arm-none-eabi-gcc packages from the AUR. Otherwise, try here:
33+
https://launchpad.net/gcc-arm-embedded
34+
35+
To build:
36+
$ cd stm
37+
$ make
38+
39+
Then to flash it via USB DFU to your device:
40+
$ dfu-util -a 0 -D build/flash.dfu
41+
42+
You will need the dfu-util program, on Arch Linux it's dfu-util-git in the AUR.

0 commit comments

Comments
 (0)