Skip to content

Commit 9a33fc0

Browse files
HumbleDeerkuba2k2
andauthored
[docs] Improve getting started guide (#252)
* Update Readme & improve md layout - ESPHome now supports LibreTiny natively - Added extra PIO docs references - Reworded some sections slightly, to accomodate proper grammar - PIO deprecated the `platformio platform install` command, replaced this with the official recommendation/replacement * Use backslash for line break, revert changing indent --------- Co-authored-by: Kuba Szczodrzyński <[email protected]>
1 parent 4cddc01 commit 9a33fc0

File tree

2 files changed

+32
-16
lines changed

2 files changed

+32
-16
lines changed

docs/getting-started/README.md

+30-16
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,60 @@
33
Using LibreTiny is simple, just like every other PlatformIO development platform.
44

55
1. [Install PlatformIO](https://platformio.org/platformio-ide)
6-
2. `platformio platform install -f https://github.com/libretiny-eu/libretiny`
6+
2. `pio pkg install --platform libretiny`
77

88
!!! tip
99
See the [Cloudcutter video guide](https://www.youtube.com/watch?v=sSj8f-HCHQ0) for a complete tutorial on flashing with [Cloudcutter](https://github.com/tuya-cloudcutter/tuya-cloudcutter) and installing [LibreTiny-ESPHome](../projects/esphome.md). **Includes Home Assistant Add-On setup.**
1010

11+
More information on Cloudcutter can be found in the [Tuya Cloudcutter GitHub repository](https://github.com/tuya-cloudcutter/tuya-cloudcutter).
12+
1113
## Board selection
1214

13-
- Go to [Boards & CPU list](../status/supported.md).
14-
- Find the board your device has (usually, the model number is written on the silkscreen).
15-
- If your board isn't available yet, use one of the "Generic" boards that matches the CPU you have.
16-
- Click on the board name. From the documentation page, note the board code.
17-
- Use this code to create a PlatformIO project.
15+
1. Navigate to the [supported boards & CPUs](../status/supported.md) list.
16+
2. Find the board your device has (usually, the model number is written on the silkscreen). \
17+
*If your board isn't available yet, use one of the "Generic" boards that matches the CPU you your board has.*
18+
3. Click on the board name. A new page opens with information about the selected board name.
19+
4. Scroll down to the "Usage" section of the page, and copy the configuration section that is relevant to your use case.
1820

1921
## Run community projects
2022

21-
LibreTiny was developed with popular community projects in mind. Currently, unofficial [ESPHome port](../projects/esphome.md) is available ([the PR](https://github.com/esphome/esphome/pull/3509) will hopefully be merged into upstream at some point).
23+
LibreTiny was developed with popular community projects in mind.
24+
25+
There is an official [ESPHome port](../projects/esphome.md) available and integrated into the ESPHome project. No extra downloads or code compilations are needed to use ESPHome with LibreTiny-supported platforms.
2226

2327
## Develop your own project
2428

25-
If you're developing your own embedded software, and want it to run on LibreTiny-supported chips, create a project.
29+
Developing your own embedded software that runs on LibreTiny-supported platforms.
30+
31+
To get started with LibreTiny on your chosen platform, create a new project using your preferred method.
2632

27-
- use PlatformIO IDE (PIO Home -> Open -> New Project)
28-
- run `pio project init` in your desired project directory
33+
There's a few ways to create a new PlatformIO Project. For example:
2934

30-
Next, read one of the [flashing guides](../flashing/SUMMARY.md) to run your project!
35+
- using the PlatformIO IDE graphical interface (PIO Home -> Open -> New Project)
36+
- by running the `pio project init` command in your desired project directory \
37+
*See the [PlatformIO Core (CLI) documentation] for information on `pio project init` and other command line usage.*
3138

32-
### LT configuration
39+
Next, read one of the [flashing guides](../flashing/SUMMARY.md) to upload and run your project!
3340

34-
LibreTiny has a few configuration options that change its behavior or features. Refer to [LT configuration](../dev/config.md) for details.
41+
### Config options (platformio.ini)
42+
43+
LibreTiny has a few configuration options that allow you to change its behavior or features. These can be defined, specified or changed in the platformio.ini configuration file for your project.
44+
45+
Refer to the LibreTiny [Configuration](../dev/config.md) manual for details.
3546

3647
### GPIO usage - important change
3748

3849
!!! important
39-
Since v1.0.0, GPIOs are no longer meant to be referenced by `D#` numbers.
50+
As of LibreTiny release v1.0.0, references to GPIO pins using their `D#` numbers has been **deprecated** and should **no longer be used** in new projects.
4051

41-
If your program is using Arduino I/O functions, refer to the [Migration guide](../dev/migration_v1.0.0.md) to modify your program accordingly.
52+
If your program is using Arduino I/O functions, please refer to the [migration guide](../dev/migration_v1.0.0.md) on how to modify your code accordingly.
4253

4354
### Examples
4455

4556
{%
4657
include-markdown "../../examples/SUMMARY.md"
47-
start="# Examples\n"
58+
start="# Examples\n"
4859
%}
60+
61+
<!-- These are reference URL's, which can be used to shorten inline hyperlinks to just their contextual title or text. -->
62+
[PlatformIO Core (CLI) documentation]: https://docs.platformio.org/en/stable/core/quickstart.html#setting-up-the-project

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ markdown_extensions:
6767
anchor_linenums: true
6868
- pymdownx.tabbed:
6969
alternate_style: true
70+
- pymdownx.escapeall:
71+
hardbreak: true
7072
- pymdownx.inlinehilite
7173
- pymdownx.details
7274
- pymdownx.superfences

0 commit comments

Comments
 (0)