More README tweaks now that master was updated
* Remove the "0.9.6; deprecated" comment regarding the master branch * Add a paragraph on enabling debugging * Clarify (I hope) the conditions under which you need to reformat your flash filesystem. * Remove trailing blanks Signed-off-by: Nick Andrew <nick@nick-andrew.net>
This commit is contained in:
parent
1217b47779
commit
570bddcfe5
16
README.md
16
README.md
|
@ -211,8 +211,7 @@ There are several options for building the NodeMCU firmware.
|
|||
|
||||
Please try Marcel's [NodeMCU custom builds](http://frightanic.com/nodemcu-custom-build) cloud service and you can choose only the modules you need, and download the firmware once built.
|
||||
|
||||
NodeMCU custom builds can build from the master branch (0.9.6; deprecated) and dev
|
||||
branch (1.4.0).
|
||||
NodeMCU custom builds can build from the master branch and dev branch (with the latest fixes).
|
||||
|
||||
## Docker containerised build
|
||||
|
||||
|
@ -316,6 +315,16 @@ editing `app/include/user_config.h` and change BIT_RATE_DEFAULT, e.g.:
|
|||
#define BIT_RATE_DEFAULT BIT_RATE_115200
|
||||
```
|
||||
|
||||
## Debugging
|
||||
|
||||
To enable runtime debug messages to serial console, edit `app/include/user_config.h`
|
||||
|
||||
```c
|
||||
#define DEVELOP_VERSION
|
||||
```
|
||||
|
||||
`DEVELOP_VERSION` changes the startup baud rate to 74880.
|
||||
|
||||
# Flash the firmware
|
||||
|
||||
## Flash tools for Windows
|
||||
|
@ -349,7 +358,8 @@ Otherwise, if you built your own firmware from source code:
|
|||
|
||||
Also, in some special circumstances, you may need to flash `blank.bin` or `esp_init_data_default.bin` to various addresses on the flash (depending on flash size and type).
|
||||
|
||||
If upgrading from `spiffs` version 0.3.2 to 0.3.3 or later, or after flashing any new firmware, you should run `file.format()` to re-format your flash filesystem.
|
||||
If upgrading from `spiffs` version 0.3.2 to 0.3.3 or later, or after flashing any new firmware (particularly one with a much different size), you may need to run `file.format()` to re-format your flash filesystem.
|
||||
You will know if you need to do this because your flash files disappeared, or they exist but seem empty, or data cannot be written to new files.
|
||||
|
||||
# Connecting to your NodeMCU device
|
||||
|
||||
|
|
Loading…
Reference in New Issue