feedc0de/bobbycar-boardcomputer-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
CommanderRedYT
2021-11-26 12:16:06 +01:00
committed by GitHub
parent e49eae2322
commit 6baa17d584
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -11,7 +11,7 @@
## How to clone ? (READ THIS OR YOU WILL FAIL) ## How to clone ? (READ THIS OR YOU WILL FAIL)
``` ```bash
git clone --recursive git@github.com:bobbycar-graz/bobbycar-boardcomputer-firmware.git git clone --recursive git@github.com:bobbycar-graz/bobbycar-boardcomputer-firmware.git
cd bobbycar-boardcomputer-firmware/ cd bobbycar-boardcomputer-firmware/
./esp-idf/install.sh ./esp-idf/install.sh
@@ -21,7 +21,7 @@ cd bobbycar-boardcomputer-firmware/
## How to compile ## How to compile
Also do the initialization if you use an IDE, otherwise build will fail. Also do the initialization if you use an IDE, otherwise build will fail.
``` ```bash
# before you try to build anything, always do this first: # before you try to build anything, always do this first:
. export.sh . export.sh
@@ -33,9 +33,17 @@ idf.py -p /dev/ttyUSB0 -b 921600 flash monitor
# flash only app (do this for development as it is much faster) # flash only app (do this for development as it is much faster)
idf.py -p /dev/ttyUSB0 -b 921600 app-flash monitor idf.py -p /dev/ttyUSB0 -b 921600 app-flash monitor
# alternative commands (After '. export.sh')
bobby-build # Builds the firmware
bobby-flash # Flashes the firmware
bobby-app-flash # Just flashes the app partition
bobby-monitor # Opens the serial monitor
bobby-coredump # Opens the coredump-utility
open-ide # Opens qtcreator
``` ```
if you are inside monitor, hit Ctrl+T then Ctrl+X to exit. If you are inside monitor, hit Ctrl+T then Ctrl+X to exit.
Hit Ctrl+T then Ctrl+A to reflash the app and return to monitor (very handy during development) Hit Ctrl+T then Ctrl+A to reflash the app and return to monitor (very handy during development)