Fix mistakes, add new make command and update the README.md

1. Correct the Coreink board ID link
2. Add patch and unpatch command to Makefile
3. Update the README.md

Author: imliubo

README.md

@@ -6,8 +6,7 @@
 
 ```shell
 mkdir uiflow_workspace && cd uiflow_workspace
-git clone https://github.com/m5stack/esp-idf.git
-git -C esp-idf checkout 8fbf4ba6058bcf736317d8a7aa75d0578563c38b
+git clone -b uiflow/v2.0-idf5.0.4 https://github.com/m5stack/esp-idf.git 
 git -C esp-idf submodule update --init --recursive
 ./esp-idf/install.sh
 . ./esp-idf/export.sh
@@ -18,38 +17,17 @@ git -C esp-idf submodule update --init --recursive
 ```shell
 git clone https://github.com/m5stack/uiflow_micropython
 cd uiflow_micropython/m5stack
-make submodules # Only need once
+make submodules
+make patch
 make littlefs
 make mpy-cross
-# Build and flash
-# atoms3
-make BOARD=M5STACK_AtomS3 pack_all flash
-# atoms3-lite
-make BOARD=M5STACK_AtomS3_Lite pack_all flash
-# atoms3u
-make BOARD=M5STACK_AtomS3U pack_all flash
-# core(BASIC/M5GO/GRAY) (Falsh 16MB)
-make BOARD=M5STACK_Basic pack_all flash
-# core(BASIC/M5GO/GRAY) (Falsh 4MB)
-make BOARD=M5STACK_Basic_4MB pack_all flash
-# capsule
-make BOARD=M5STACK_Capsule pack_all flash
-# core2,tough
-make BOARD=M5STACK_Core2 pack_all flash
-# cores3
-make BOARD=M5STACK_CoreS3 pack_all flash
-# dial
-make BOARD=M5STACK_Dial pack_all flash
-# fire
-make BOARD=M5STACK_Fire pack_all flash
-# stamps3
-make BOARD=M5STACK_StampS3 pack_all flash
-# stickcplus
-make BOARD=M5STACK_StickC_PLUS pack_all flash
-# stickcplus2
-make BOARD=M5STACK_StickC_PLUS2 pack_all flash
+make flash_all
 ```
 
+The default board build the M5STACK_AtomS3 one, You can specify a different board by passing `BOARD=<board>` to the make commands. More BOARD type define is under [m5satck/boards](./m5stack/boards/) path.
+
+More command support, you can check the [Makefile](./m5stack/Makefile).
+
 ## Documentation
 
 API documentation for this library can be found on [Read the Docs](https://uiflow-micropython.readthedocs.io/en/latest/).

m5stack/Makefile

@@ -2,10 +2,6 @@
 #
 # This is a simple, convenience wrapper around idf.py (which uses cmake).
 
-# Select the mcu type to build, default is M5STACK_8MB
-# M5STACK_xxx    -> ESP32
-# M5STACK_C3_xxx -> ESP32 C3
-# M5STACK_S3_xxx -> ESP32 S3
 -include .workenv
 
 BOARD ?= M5STACK_AtomS3
@@ -83,7 +79,6 @@ endif
 BUILD ?= build-$(BOARD)
 
 # Device serial settings.
-#PORT ?= /dev/ttyS8
 PORT ?= /dev/ttyUSB0
 BAUD ?= 1500000
 
@@ -102,6 +97,7 @@ endif
 
 IDFPY_FLAGS += -DMICROPY_BOARD=$(BOARD) -DBUILD_WITH_LVGL=$(LVGL) -B$(BUILD) $(CMAKE_ARGS)
 IDFPY_FLAGS += -DBOARD_TYPE=$(BOARD_TYPE)
+
 ifdef FROZEN_MANIFEST
        IDFPY_FLAGS += -D MICROPY_FROZEN_MANIFEST=$(FROZEN_MANIFEST)
 endif
@@ -138,53 +134,48 @@ all: nvs fs pack
 
 $(BUILD)/bootloader/bootloader.bin $(BUILD)/partition_table/partition-table.bin $(BUILD)/micropython.bin: FORCE
 
-# config the menu
+# Config menu
 menu:
 	idf.py $(IDFPY_FLAGS) menuconfig
 
+# Show the size summary
 size: 
 	idf.py $(IDFPY_FLAGS) size
 
-# Build the MicroPython firmware.
+# Build the MicroPython firmware
 build: nvs
 	idf.py $(IDFPY_FLAGS) build
 
-# Deploy the MicroPython.
+# Deploy the MicroPython firmware
 deploy: build
 	idf.py $(IDFPY_FLAGS) -p $(PORT) -b $(BAUD) flash
 
-# Deploy the MicroPython and system filesystem.
+# Deploy the MicroPython and system filesystem
 flash: pack
 	esptool.py --chip $(CHIP) --port $(PORT) --baud $(BAUD) write_flash 0x0 $(BUILD)/uiflow-$(GIT_VERSION).bin
 
-# Deploy the MicroPython, system filesystem and user filesystem.
+# Deploy the MicroPython, system filesystem and user filesystem
 flash_all: pack_all
 	esptool.py --chip $(CHIP) --port $(PORT) --baud $(BAUD) write_flash 0x0 $(BUILD)/uiflow-$(GIT_VERSION).bin
 
-# Clean the build directory.
+# Clean the build directory
 clean:
 	idf.py $(IDFPY_FLAGS) fullclean
-	# cd ./../micropython && \
-	# git apply --reverse ./../m5stack/patches/0001_mpconfigport_lvgl_support.patch && cd -
-	cd ./components/lv_bindings && \
-	git apply --reverse ./../../patches/0002_avoid_lv_bindings_compile_error.patch && cd -
-	cd ./components/M5Unified/M5Unified && \
-	git apply --reverse ./../../../patches/2003-Support-LTR553.patch && cd -
 
-# Erase the flash chip.
+# Erase the flash chip
 erase:
 	idf.py $(IDFPY_FLAGS) -p $(PORT) -b $(BAUD) erase_flash
 
-# Run the serial monitor.
+# Run the serial monitor
 monitor:
 	idf.py $(IDFPY_FLAGS) -p $(PORT) -b $(BAUD) monitor
 
-# Build the NVS partition firmware.
+# Build the NVS partition firmware
 # fixed size 0x6000
 nvs:
 	@$(PYTHON) ./../tools/nvs_partition_gen.py generate partition_nvs.csv $(BUILD)/nvs.bin 0x6000
 
-# Build the system and user filesystem firmware.
+# Build the system and user filesystem firmware
 ifeq ($(TINY_FLAG),1)
 fs: build
 	@if [ ! -d $(BUILD)/base-files ]; then \
@@ -216,8 +207,6 @@ fs: build
 			$(BUILD)/partition_table/partition-table.bin
 endif
 
-
-
 # Pack the firmware into a single binary without user filesystem.
 # Released firmware needn't user filesystem.
 pack: fs
@@ -238,7 +227,6 @@ mpy-cross:
 # The two submodules do not belong to the same repository
 # micropython submodule belong to uiflow_micropython
 # berkeley-db-1.xx submodule belong to micropython submodule
-# TODO: need update this :)
 submodules:
 	git submodule update --init ../tools/littlefs/mbed-littlefs
 	git submodule update --init ./components/esp32-camera
@@ -247,7 +235,17 @@ submodules:
 	git submodule update --init --recursive ./components/lv_bindings
 	git submodule update --init ../micropython
 	cd ./../micropython && git submodule update --init $(addprefix ./,$(GIT_SUBMODULES)) && cd -
+
+# Apply patches
+patch:
 	cd ./components/lv_bindings && \
 	git apply ./../../patches/0002_avoid_lv_bindings_compile_error.patch && cd -
 	cd ./components/M5Unified/M5Unified && \
 	git apply ./../../../patches/2003-Support-LTR553.patch && cd -
+
+# Unapply patches
+unpatch:
+	cd ./components/lv_bindings && \
+	git apply -R ./../../patches/0002_avoid_lv_bindings_compile_error.patch && cd -
+	cd ./components/M5Unified/M5Unified && \
+	git apply -R ./../../../patches/2003-Support-LTR553.patch && cd -

m5stack/boards/M5STACK_CoreInk/mpconfigboard.cmake

@@ -1,4 +1,4 @@
-# stickc-plus https://github.com/m5stack/m5stack-board-id/blob/558d0c4e4fc55a72805827c65a5255aa4b844515/board.csv#L6
+# coreink https://github.com/m5stack/m5stack-board-id/blob/558d0c4e4fc55a72805827c65a5255aa4b844515/board.csv#L8
 set(BOARD_ID 6)
 
 set(SDKCONFIG_DEFAULTS
@@ -7,7 +7,7 @@ set(SDKCONFIG_DEFAULTS
     ./boards/sdkconfig.ble
     ./boards/sdkconfig.240mhz
     ./boards/sdkconfig.disable_iram
-    ./boards/M5STACK_StickC_PLUS/sdkconfig.board
+    ./boards/M5STACK_CoreInk/sdkconfig.board
 )
 
 # If not enable LVGL, ignore this...