Skip to content

Commit eb101a2

Browse files
committed
examples/embedding/README: Convert to markdown, grammar and clarity fixes.
1 parent e5cc681 commit eb101a2

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed
Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Python statement which prints to the standard output.
1111
Building the example
1212
--------------------
1313

14-
Build the example is as simple as running:
14+
Building the example is as simple as running:
1515

1616
make
1717

@@ -20,37 +20,38 @@ It's worth to trace what's happening behind the scenes though:
2020
1. As a first step, a MicroPython library is built. This is handled by a
2121
seperate makefile, Makefile.upylib. It is more or less complex, but the
2222
good news is that you won't need to change anything in it, just use it
23-
as is, the main Makefile shows how. What may need editing though is
24-
MicroPython configuration file. MicroPython is highly configurable, so
23+
as is, the main Makefile shows how. What may require editing though is
24+
a MicroPython configuration file. MicroPython is highly configurable, so
2525
you would need to build a library suiting your application well, while
2626
not bloating its size. Check the options in the file "mpconfigport.h".
27-
Included is a copy of "minimal" Unix port, which should be good start
28-
for minimal embedding. For list of all available options, see py/mpconfig.h.
27+
Included is a copy of the "minimal" Unix port, which should be a good start
28+
for minimal embedding. For the list of all available options, see
29+
py/mpconfig.h.
2930

30-
2. Once the library is built, your application is compiled and linked with
31-
the MicroPython library produced in the previous step. The main Makefile
32-
is very simple and shows that changes you would need to do to your
33-
application's Makefile (or other build configuration) are also simple:
31+
2. Once the MicroPython library is built, your application is compiled
32+
and linked it. The main Makefile is very simple and shows that the changes
33+
you would need to do to your application's Makefile (or other build
34+
configuration) are also simple:
3435

35-
a) You would need to use C99 standard (you're using 15+ years old standard
36-
already, not a 25+ years old one, right?).
36+
a) You would need to use C99 standard (you're using this 15+ years old
37+
standard already, not a 25+ years old one, right?).
3738

38-
b) You need to provide path to MicroPython's top-level dir, for includes.
39+
b) You need to provide a path to MicroPython's top-level dir, for includes.
3940

4041
c) You need to include -DNO_QSTR compile-time flag.
4142

42-
d) Otherwise, just link with micropython library produced in step 1.
43+
d) Otherwise, just link with the MicroPython library produced in step 1.
4344

4445

4546
Out of tree build
4647
-----------------
4748

48-
This example set up to work out of the box, being part of the MicroPython
49+
This example is set up to work out of the box, being part of the MicroPython
4950
tree. Your application of course will be outside of its tree, but the
5051
only thing you need to do is to pass MPTOP variable pointing to
5152
MicroPython directory to both Makefiles (in this example, the main Makefile
52-
automatically pass it to Makefile.upylib; in your own Makefile, don't forget
53-
to use suitable value).
53+
automatically passes it to Makefile.upylib; in your own Makefile, don't forget
54+
to use a suitable value).
5455

5556
A practical way to embed MicroPython in your application is to include it
5657
as a git submodule. Suppose you included it as libs/micropython. Then in

0 commit comments

Comments
 (0)