8000 zephyr: Add README. · pcurry/circuitpython@89bfbfd · GitHub
[go: up one dir, main page]

Skip to content

Commit 89bfbfd

Browse files
committed
zephyr: Add README.
1 parent a181340 commit 89bfbfd

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

zephyr/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
MicroPython port to Zephyr RTOS
2+
===============================
3+
4+
This is an initial port of MicroPython to Zephyr RTOS
5+
(http://zephyrproject.org).
6+
7+
The port integrates well with Zephyr build system, using the latest
8+
features which will be available in 1.6.0, and thus requires Zephyr
9+
master to build against. All boards supported by Zephyr should be
10+
supported (but not all were tested).
11+
12+
At this time, only basic interactive prompt (REPL) over UART connection
13+
is supported. Over time, bindings for various Zephyr subsystems may
14+
be added.
15+
16+
17+
Building
18+
--------
19+
20+
Follow to Zephyr web site for Getting Started instruction of installing
21+
Zephyr SDK, getting Zephyr source code, and setting up development
22+
environment. (Direct link:
23+
https://www.zephyrproject.org/doc/getting_started/getting_started.html).
24+
You may want to build Zephyr's own sample applications to make sure your
25+
setup is correct.
26+
27+
To build MicroPython port, in the port subdirectory (zephyr/), run:
28+
29+
make BOARD=<board>
30+
31+
If you don't specify BOARD, the default is `qemu_x86` (x86 target running
32+
in QEMU emulator). Consult Zephyr documentation above for the list of
33+
supported boards.
34+
35+
36+
Running
37+
-------
38+
39+
To run the resulting application in QEMU (for BOARDs like qemu_x86,
40+
qemu_cortex_m3):
41+
42+
make qemu
43+
44+
For deploying/flashing teh application on a real board, follow Zephyr
45+
documentation for a given board.

0 commit comments

Comments
 (0)
0