From be772ec56f292c1914337eefb18fae7b9d78295a Mon Sep 17 00:00:00 2001 From: Tim Becker Date: Tue, 12 Jul 2022 20:02:05 +0200 Subject: [PATCH] make s default task prepares. README desc make tagets --- Makefile | 4 ++-- README.md | 29 ++++++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 2edab9b..99ea022 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,9 @@ IDF_PATH ?= $(shell pwd)/esp-idf IDF_EXPORT_QUIET ?= 0 SHELL := /usr/bin/env bash -.PHONY: prepare clean build flash erase monitor menuconfig +.PHONY: prepare clean build flash monitor menuconfig -all: install +all: prepare build install prepare: git submodule update --init --recursive diff --git a/README.md b/README.md index 37e7a2d..d940f21 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,33 @@ corresponding tips. ```sh git clone --recursive https://github.com/badgeteam/mch2022-template-app cd mch2022-template-app -make prepare make ``` + +The default target of the Makefile (the one executed if you just run `make`) installs the proper ESP-IDF version and all other dependencies, then builds the project and tries to install it on an attached Badge. Because this process checks all the dependencies for updates, this can become tedious during development, so you'll probably want to execute specific targets: + +- prepare : this is (one of) the targets executed in the default task and the one that, technically, only needs to run once to install dependencies +- clean : clean the build environment. This does NOT clean up installed dependencies. +- build : well ... build. Compiles you sources and assembles a binary to install. +- install : This install the binary that was build, you can only call `install`, it depends on `build`. *Note* installation is not and SHOULD NOT be performed with the typical `idf.py flash` call, see the note below for details. +- monitor : start the serial monitor to examine log output +- menuconfig : The IDF build system has a fairly elaborate configuration system that can be accessed via `menuconfig`. You'll know if you need it. Or try it out to explore. + + +### Note: Why not to use `idf.py flash` to install my native app. + +If you have previously used the IDF, you may have noticed that we don’t use +`idf.py flash` to install the app on the Badge. (And if you haven’t, you can +safely skip this section. :) + +The `idf.py flash` command assumes that the binary to flash is the main (and +only) application for the device. This is not the case for the Badge, though. +The main application is the launcher app, i.e. the app with the menu that +starts by default. The `make install` target of the Makefile copies our newly +created app into the +[appfs](https://github.com/badgeteam/esp32-component-appfThe Makefile cs) +instead of overwriting the launcher. Once copied to the appfs, the launcher can +find your app and it should appear in the apps menu. + +Obviously you _can_ use idf.py flash but you’ll delete the launcher app and would +need to reinstall it later.