Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(examples): correct readme broken links #110

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions examples/LVGL/v8/Porting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Follow the steps below to configure:

1. For **ESP32_Display_Panel**:

- Follow the [steps](../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../README.md#using-custom-development-boards) to configure it.
- Follow the [steps](../../../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../../../README.md#using-custom-development-boards) to configure it.

2. For **lvgl**:

- Follow the [steps](../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Follow the [steps](../../../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Modify the macros in the [lvgl_port_v8.h](./lvgl_port_v8.h) file to configure the LVGL porting parameters.

3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../README.md#configuring-supported-development-boards)
3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../../../README.md#configuring-supported-development-boards)
4. Verify and upload the example to your ESP board.

## Serial Output
Expand Down
10 changes: 5 additions & 5 deletions examples/LVGL/v8/Rotation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Then follow the steps below to configure:

1. For **ESP32_Display_Panel**:

- Follow the [steps](../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../README.md#using-custom-development-boards) to configure it.
- Follow the [steps](../../../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../../../README.md#using-custom-development-boards) to configure it.

2. For **lvgl**:

- Follow the [steps](../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Follow the [steps](../../../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Modify the macros in the [lvgl_port_v8.h](./lvgl_port_v8.h) file to configure the LVGL porting parameters.

3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../README.md#configuring-supported-development-boards)
3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../../../README.md#configuring-supported-development-boards)
4. Verify and upload the example to your ESP board.

## Serial Output
Expand Down
8 changes: 4 additions & 4 deletions examples/Panel/PanelTest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Follow the steps below to configure:

1. For **ESP32_Display_Panel**:

- Follow the [steps](../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../README.md#using-custom-development-boards) to configure it.
- Follow the [steps](../../../README.md#configuring-drivers) to configure drivers if needed.
- If using a supported development board, follow the [steps](../../../README.md#using-supported-development-boards) to configure it.
- If using a custom board, follow the [steps](../../../README.md#using-custom-development-boards) to configure it.

3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../README.md#configuring-supported-development-boards)
3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../../README.md#configuring-supported-development-boards)
4. Verify and upload the example to your ESP board.

## Serial Output
Expand Down
4 changes: 2 additions & 2 deletions examples/SquareLine/v8/Porting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Then follow the steps below to configure:

2. For **lvgl**:

- Follow the [steps](../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Follow the [steps](../../../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
- Modify the macros in the [lvgl_port_v8.h](./lvgl_port_v8.h) file to configure the LVGL porting parameters.

3. To directly use the example, please copy the [ui](./libraries/ui/) folder from `libraries` to [Arduino Library directory](../../../../README.md#where-is-the-directory-for-arduino-libraries). What's more, you can follow the [steps](../../../../README.md#porting-squareline-project) to port your own **SquareLine** project.
4. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../README.md#configuring-supported-development-boards)
4. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../../../README.md#configuring-supported-development-boards)
5. Verify and upload the example to your ESP board.

## Serial Output
Expand Down
Loading