From 6baa17d58469dd7caae22a1575eece3ffcb394b3 Mon Sep 17 00:00:00 2001 From: CommanderRedYT Date: Fri, 26 Nov 2021 12:16:06 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c19ebb..a7fda54 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ## How to clone ? (READ THIS OR YOU WILL FAIL) -``` +```bash git clone --recursive git@github.com:bobbycar-graz/bobbycar-boardcomputer-firmware.git cd bobbycar-boardcomputer-firmware/ ./esp-idf/install.sh @@ -21,7 +21,7 @@ cd bobbycar-boardcomputer-firmware/ ## How to compile Also do the initialization if you use an IDE, otherwise build will fail. -``` +```bash # before you try to build anything, always do this first: . 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) 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)