Enhancement/docs: Updated README.md And config.toml File. #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adwait-esp
requested changes
Oct 11, 2023
README.md
Outdated
| @@ -32,12 +32,14 @@ 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 support phone apps to work along with this firmware and 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) | |||
There was a problem hiding this comment.
typo : link to any supported phone apps instead of support phone apps.
- also break down the sentence. Start the next on a new line - You can also include additional information ....
RushikeshPatange
force-pushed
the
docs/update_readme_and_config_toml
branch
from
1effb0f
to
f417182
Compare
RushikeshPatange
force-pushed
the
docs/update_readme_and_config_toml
branch
from
f417182
to
82e3fef
Compare
adwait-esp
approved these changes
Oct 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Does This PR Do?
This PR makes the following enhancements:
Test Link ?
You can take a look on updated README.md and config.toml file on my branch docs/update_readme_and_config_toml