Skip to content

Commit 5fbdcc9

Browse files
committed
update the step for build and modify Makefile for init submodule
1 parent c148d16 commit 5fbdcc9

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# uiflow_micropython
22

3-
## build
3+
## How to build
4+
### Setting up ESP-IDF and the build environment
5+
```shell
6+
mkdir uiflow_workspace && cd uiflow_workspace
7+
git clone https://github.com/m5stack/esp-idf.git
8+
git -C esp-idf checkout 014ee65f1f5e291230e398c4913020be9a6278a1
9+
git -C esp-idf submodule update --init --recursive
10+
./esp-idf/install.sh
11+
```
412

13+
### Building the firmware
514
```shell
6-
git clone https://github.com/m5stack/uiflow_micropython --recursive
15+
git clone https://github.com/m5stack/uiflow_micropython
716
cd uiflow_micropython/m5stack
817
make submodules
918
make mpy-cross

m5stack/Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ PYTHON ?= python3
1717

1818
GIT_SUBMODULES = lib/berkeley-db-1.xx
1919

20-
.PHONY: all clean deploy erase submodules FORCE
20+
.PHONY: all clean deploy erase mpy-cross submodules FORCE
2121

2222
MAKEFILE_DIR:=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
2323

@@ -61,5 +61,9 @@ erase:
6161
mpy-cross:
6262
make -C ../micropython/mpy-cross
6363

64+
# The two submodules do not belong to the same repository
65+
# micropython submodule belong to uiflow_micropython
66+
# berkeley-db-1.xx submodule belong to micropython submodule
6467
submodules:
68+
git submodule update --init ../micropython
6569
cd ./../micropython && git submodule update --init $(addprefix ./,$(GIT_SUBMODULES)) && cd -

0 commit comments

Comments
 (0)