From 9b9a218f6e8825b214564e3735140fd9bcbde00a Mon Sep 17 00:00:00 2001 From: Johnny <985648+johnny9@users.noreply.github.com> Date: Sun, 7 May 2023 10:48:48 -0400 Subject: [PATCH] README: change order of build and unit test sections for clarity --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fb439864..61880f15 100755 --- a/README.md +++ b/README.md @@ -44,6 +44,18 @@ Username is currently hardcoded in miner.c. Modify the define to change. #define STRATUM_USERNAME "johnny9.esp" ``` +## Build and Flash + +Build the project and flash it to the board, then run monitor tool to view serial output: + +``` +idf.py -p PORT flash monitor +``` + +(To exit the serial monitor, type ``Ctrl-]``.) + +See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects. + ## Run Unit tests The unit tests for the project use the unity test framework and currently require actual esp32 hardware to run. @@ -56,14 +68,3 @@ idf.py set-target esp32s3 idf.py -p PORT flash monitor ``` -## Build and Flash - -Build the project and flash it to the board, then run monitor tool to view serial output: - -``` -idf.py -p PORT flash monitor -``` - -(To exit the serial monitor, type ``Ctrl-]``.) - -See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.