Explorar o código

Fix formatting in the docs.

DarkMorford %!s(int64=6) %!d(string=hai) anos
pai
achega
63fdd70be7
Modificáronse 1 ficheiros con 8 adicións e 13 borrados
  1. 8 13
      code/README.md

+ 8 - 13
code/README.md

@@ -11,9 +11,11 @@ You may experience different results running in a different environment.
 2. Install the `pipenv` virtual environment tool following the [official documentation](https://pipenv.readthedocs.io/en/latest/install).
 3. From a terminal, execute the following commands:
 
-    git clone https://code.darkmorford.net/DesertBusForHope/rdp-button.git
-    cd rdp-button
-    pipenv install
+```shell
+git clone https://code.darkmorford.net/DesertBusForHope/rdp-button.git
+cd rdp-button/code
+pipenv install
+```
 
 This will create a virtual Python environment and install two essential tools:
 [esptool](https://github.com/espressif/esptool), used for flashing firmware to the device, and
@@ -24,15 +26,8 @@ This will create a virtual Python environment and install two essential tools:
 1. Connect the ESP8266 module to your computer and determine its serial port identifier.
   * For Windows machines, this will be something like `COM1`
   * For Linux/macOS, this will be something like `/dev/ttyUSB0`
-2. From this directory (the one containing `Pipfile`), run the following command to clear the ESP8266's flash memory:
-
-    pipenv run esptool --port <port> erase_flash
+2. From this directory (the one containing `Pipfile`), run the following command to clear the ESP8266's flash memory: `pipenv run esptool --port <port> erase_flash`
 
 3. Flash the MicroPython firmware onto the ESP8266. This will vary slightly depending on your board.
-  * In most cases, flashing with the default quad-I/O mode will work fine:
-
-    pipenv run esptool --port <port> --baud 460800 write_flash --flash_size detect 0 MicroPython/esp8266-20180511-v1.9.4.bin
-
-  * For some boards, it is necessary to fall back to the dual-I/O mode:
-
-    pipenv run esptool --port <port> --baud 460800 write_flash --flash_size detect --flash_mode dio 0 MicroPython/esp8266-20180511-v1.9.4.bin
+  * In most cases, flashing with the default quad-I/O mode will work fine: `pipenv run esptool --port <port> --baud 460800 write_flash --flash_size detect 0 MicroPython/esp8266-20180511-v1.9.4.bin`
+  * For some boards, it is necessary to fall back to the dual-I/O mode: `pipenv run esptool --port <port> --baud 460800 write_flash --flash_size detect --flash_mode dio 0 MicroPython/esp8266-20180511-v1.9.4.bin`