diff --git a/README.md b/README.md index bed49cc..beb6502 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ aspect of the lamp and to integrate the lamp in your Home Assistant setup. For those who have experience with flashing ESPHome onto devices: * Make sure you are using ESPHome v1.18.0 or newer. -* Copy `[example.yaml](example.yaml)` to `/.yaml`. +* Copy [`example.yaml`](example.yaml) to `/.yaml`. * Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)). * Compile the `firmware.bin` file and download it to the device to which you have connected your serial to USB adapter. diff --git a/doc/configuration.md b/doc/configuration.md index b3bb6f1..00edc6f 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -3,7 +3,7 @@ # Configuration guide I think, the best starting point for creating your own yaml configuration, is to look at the -[example.yaml](../example.yaml) file from the project documentation. This configuration was written +[`example.yaml`](../example.yaml) file from the project documentation. This configuration was written with the functionality of the original firmware in mind and it makes use of all available options. This configuration guide can be used to fill in the blanks. @@ -33,7 +33,7 @@ I do mention the platform configuration here for completeness sake, but **genera to add the following configuration option to your yaml file**. It is loaded automatically by the components that need it, and the GPIO + I2C configurations are fully prepared to work for the Bedside Lamp 2 wiring out of the box. Therefore, you will not find this piece of configuration in -the [example.yaml](../example.yaml). +the [`example.yaml`](../example.yaml). Having said that, here are the configuration options: diff --git a/doc/installation.md b/doc/installation.md index 206144b..f69629b 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -12,7 +12,7 @@ the code manually. This leverages the external components feature that was intro v1.18.0. Therefore, you must use ESPHome v1.18.0 or later. Before you can compile the firmware, you will have to create the YAML configuration file for your -device. You can take the [example.yaml](../example.yaml) from this repository as a starting point, and +device. You can take the [`example.yaml`](../example.yaml) from this repository as a starting point, and modify that one to your needs. Detailed information about the YAML configuration options can be found in the [Configuration guide](configuration.md). diff --git a/doc/testplan.md b/doc/testplan.md index 715ed20..b500829 100644 --- a/doc/testplan.md +++ b/doc/testplan.md @@ -13,7 +13,7 @@ been introduced. * Remove the cached framework package: `/bin/rm -fR ~/.platformio/packages/framework-arduinoespressif32` -* Copy `[example.yaml](../example.yaml)` to a clean build directory, and update the first two sections for the +* Copy [`example.yaml`](../example.yaml) to a clean build directory, and update the first two sections for the local setup (substitutions, wifi, api, ota). * Use `esphome example.yaml compile` to build the code.