mirrors/mch2022-template-app
1
0
Fork 1
mirror of https://github.com/badgeteam/mch2022-template-app.git synced 2025-01-07 14:55:34 +00:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse source
This commit is contained in:
Renze Nicolai 2023-04-22 18:42:23 +02:00
parent a4555b93bc
commit c88b7fa18f
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -33,15 +33,15 @@ corresponding tips.
```sh ```sh
git clone --recursive https://github.com/badgeteam/mch2022-template-app git clone --recursive https://github.com/badgeteam/mch2022-template-app
cd mch2022-template-app cd mch2022-template-app
make make prepare build install
``` ```
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: 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 - prepare : install the SDK and dependencies
- clean : clean the build environment. This does NOT clean up installed 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. - build : compiles the app and assembles a binary.
- 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. - install : this installs 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 - 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. - 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.
@ -50,14 +50,13 @@ The default target of the Makefile (the one executed if you just run `make`) ins
If you have previously used the IDF, you may have noticed that we don’t use 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 `idf.py flash` to install the app on the Badge. (And if you haven’t, you can
safely skip this section. :) safely skip this section.)
The `idf.py flash` command assumes that the binary to flash is the main (and 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. 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 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 starts by default. The `make install` target of the Makefile copies our newly
created app into the created app into the [appfs](https://github.com/badgeteam/esp32-component-appfs)
[appfs](https://github.com/badgeteam/esp32-component-appfThe Makefile cs)
instead of overwriting the launcher. Once copied to the appfs, the launcher can instead of overwriting the launcher. Once copied to the appfs, the launcher can
find your app and it should appear in the apps menu. find your app and it should appear in the apps menu.