aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDamien George2019-10-14 12:09:06 +1100
committerDamien George2019-10-15 17:14:41 +1100
commitd7a9388fe0ac3b6df9e5994da1343488b17469cd (patch)
treedbe549dfc45d707827cb753574d8f038fd5da20a /README.md
parent3ee71ff314c33410964edff6e12ffc638d2df661 (diff)
ports: Add new make target "submodules" which inits required modules.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index aaf310b66..ed0f20091 100644
--- a/README.md
+++ b/README.md
@@ -86,8 +86,8 @@ Alternatively, fallback implementation based on setjmp/longjmp can be used.
To build (see section below for required dependencies):
- $ git submodule update --init
$ cd ports/unix
+ $ make submodules
$ make
Then to give it a try:
@@ -127,13 +127,14 @@ Debian/Ubuntu/Mint derivative Linux distros, install `build-essential`
Other dependencies can be built together with MicroPython. This may
be required to enable extra features or capabilities, and in recent
versions of MicroPython, these may be enabled by default. To build
-these additional dependencies, first fetch git submodules for them:
+these additional dependencies, in the port directory you're
+interested in (e.g. `ports/unix/`) first execute:
- $ git submodule update --init
+ $ make submodules
-Use the same command to get the latest versions of dependencies, as
-they are updated from time to time. After that, in the port directory
-(e.g. `ports/unix/`), execute:
+This will fetch all the relevant git submodules (sub repositories) that
+the port needs. Use the same command to get the latest versions of
+submodules as they are updated from time to time. After that execute:
$ make deplibs
@@ -146,8 +147,8 @@ For example, to build SSL module (required for `upip` tool described above,
and so enabled by dfeault), `MICROPY_PY_USSL` should be set to 1.
For some ports, building required dependences is transparent, and happens
-automatically. They still need to be fetched with the git submodule command
-above.
+automatically. But they still need to be fetched with the `make submodules`
+command.
The STM32 version
-----------------
@@ -159,8 +160,8 @@ https://launchpad.net/gcc-arm-embedded
To build:
- $ git submodule update --init
$ cd ports/stm32
+ $ make submodules
$ make
You then need to get your board into DFU mode. On the pyboard, connect the