From 3c6708903c7a701d9e3d24bf2897e3a5895413d0 Mon Sep 17 00:00:00 2001 From: Rushikesh Patange <90703337+RushikeshPatange@users.noreply.github.com> Date: Wed, 11 Oct 2023 17:02:51 +0530 Subject: [PATCH] Enhancement/docs: Updated README.md and config.toml file. (#46) Co-authored-by: Rushikesh Patange --- README.md | 16 ++++++++++------ config/config.toml | 4 +++- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1c6e866..1c3f6b3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ESP Launchpad is a web based tool, available for flashing firmware application t There are two modes available for using this tool: - Quick Start : 4 Easy Steps - Plug, Connect, Choose Built-In Firmware Image, Flash! -- DIY : For Advanced Users, use your own pre-built Firmware Image from local storage and Flash! +- DIY : For Advanced Users, use your own pre-built Firmware Image from local storage and Flash! **Quick Start:** @@ -32,12 +32,16 @@ The firmware will be flashed on to your connected device. You can watch the prog ESP Launchpad also lets you easily publish your firmware apps for others to try. -The ESP Launchpad Quick Start page would be rendered by referring to a TOML configuration file, where you can configure where to pick all the component images of your firmware, and the supported hardware. You could also link to any support phone apps to work along with this firmware. A sample TOML config file can be viewed here +The ESP Launchpad Quick Start page would be rendered by referring to a TOML configuration file, where you can configure where to pick all the component images of your firmware, and the supported hardware. You could also link to any supported phone apps to work along with this firmware. + +You can also include additional information about your application in **Markdown format** within the TOML config file itself. ESP Launchpad will then render the application information and any additional instructions in the browser after flashing the firmware image. A sample TOML config file can be viewed [here](https://github.com/espressif/esp-launchpad/blob/main/config/config.toml) Rest of the flashing procedure is same easy 4 step process as the Quick Start one above. Once ready, you can use the following image and URL for supporting ESP Launchpad with your configuration. -` - Try it with ESP Launchpad -` \ No newline at end of file + +``` + + Try it with ESP Launchpad + +``` \ No newline at end of file diff --git a/config/config.toml b/config/config.toml index 8ad4590..bacabfd 100644 --- a/config/config.toml +++ b/config/config.toml @@ -18,4 +18,6 @@ image.esp32-s2 = "SINGLE_BIN_FOR_ESP32-S2.bin" image.esp32-c3 = "SINGLE_BIN_FOR_ESP32-C3.bin" # Optional: Phone APP URLs if any for Playstores android_app_url = "" -ios_app_url = "" \ No newline at end of file +ios_app_url = "" +# Optional: URL of the Markdown file for additional information about the app +readme.text = "" \ No newline at end of file