Skip to content

Commit 2fbfb9d

Browse files
committed
Updated readme / doc
changed links to examples
1 parent 970172d commit 2fbfb9d

File tree

2 files changed

+4
-23
lines changed

2 files changed

+4
-23
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
1. Install [VS Code](https://code.visualstudio.com/)
88
2. Install [PlatformIO](https://platformio.org/platformio-ide)
99
3. Install **SinricPro** library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/)
10-
4. Use included [platformio.ini](https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/pio-examples/switch/platformio.ini) files from [examples](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples) to ensure that all dependent libraries will installed automaticly.
10+
4. Use included [platformio.ini](examples/platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automaticly.
1111

1212
![sinricpro library manager](https://raw.githubusercontent.com/sinricpro/images/master/platformio-install-sinricpro.png)
1313

@@ -28,13 +28,7 @@
2828
---
2929

3030
## Examples
31-
|PlatformIO|Arduino|
32-
|:--:|:--:|
33-
| [Switch](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/switch) |[Switch](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/Switch)|
34-
| [Doorbell](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/doorbell)|[Doorbell](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/doorbell)|
35-
| - | [Lock](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/GarageDoor)|
36-
| [TemperatureSensor](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/temperaturesensor) |[TemperatureSensor](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/temperaturesensor)|
37-
| [TV](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/tv) | [TV](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/tv)
31+
See [examples](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples) on GitHub
3832

3933
---
4034

docs/index.html

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2><a class="anchor" id="autotoc_md3"></a>
119119
</li>
120120
<li>Install <b><a class="el" href="class_sinric_pro.html" title="The main instance of SinricProClass.">SinricPro</a></b> library by using <a href="https://docs.platformio.org/en/latest/librarymanager/">Library Manager</a> <br />
121121
</li>
122-
<li>Use included <a href="https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/pio-examples/switch/platformio.ini">platformio.ini</a> files from <a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples">examples</a> to ensure that all dependent libraries will installed automaticly.</li>
122+
<li>Use included <a href="examples/platformio/platformio.ini">platformio.ini</a> file from examples to ensure that all dependent libraries will installed automaticly.</li>
123123
</ol>
124124
<p><img src="https://raw.githubusercontent.com/sinricpro/images/master/platformio-install-sinricpro.png" alt="sinricpro library manager" class="inline"/></p>
125125
<h2><a class="anchor" id="autotoc_md4"></a>
@@ -143,20 +143,7 @@ <h1><a class="anchor" id="autotoc_md6"></a>
143143
<hr />
144144
<h1><a class="anchor" id="autotoc_md8"></a>
145145
Examples</h1>
146-
<table class="markdownTable">
147-
<tr class="markdownTableHead">
148-
<th class="markdownTableHeadCenter">PlatformIO </th><th class="markdownTableHeadCenter">Arduino </th></tr>
149-
<tr class="markdownTableRowOdd">
150-
<td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/switch">Switch</a> </td><td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/Switch">Switch</a> </td></tr>
151-
<tr class="markdownTableRowEven">
152-
<td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/doorbell">Doorbell</a> </td><td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/doorbell">Doorbell</a> </td></tr>
153-
<tr class="markdownTableRowOdd">
154-
<td class="markdownTableBodyCenter">- </td><td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/GarageDoor">Lock</a> </td></tr>
155-
<tr class="markdownTableRowEven">
156-
<td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/temperaturesensor">TemperatureSensor</a> </td><td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/temperaturesensor">TemperatureSensor</a> </td></tr>
157-
<tr class="markdownTableRowOdd">
158-
<td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/pio-examples/tv">TV</a> </td><td class="markdownTableBodyCenter"><a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/tv">TV</a> </td></tr>
159-
</table>
146+
<p>See <a href="https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples">examples</a> on GitHub</p>
160147
<hr />
161148
<h1><a class="anchor" id="autotoc_md10"></a>
162149
Usage</h1>

0 commit comments

Comments
 (0)