Skip to content

Commit bb5650a

Browse files
committed
update how to get started
1 parent aa272ec commit bb5650a

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,20 @@ MeshCore provides the ability to create wireless mesh networks, similar to Mesht
2727

2828
- Watch the [MeshCore Intro Video](https://www.youtube.com/watch?v=t1qne8uJBAc) by Andy Kirby.
2929
- Read through our [Frequently Asked Questions](./docs/faq.md) section.
30+
- Flash the MeshCore firmware on a supported device.
31+
- Connect with a supported client.
3032

31-
For developers, install [PlatformIO](https://docs.platformio.org) in Visual Studio Code.
32-
Download & Open the MeshCore repository.
33-
Select a Sample Application: Choose from chat, repeater, other example app.
34-
Monitor & Communicate using the Serial Monitor (e.g., Serial USB Terminal on Android).
33+
For developers;
3534

36-
📁 Included Example Applications
37-
* 📡 Terminal Chat: Secure text communication between devices.
38-
* 📡 Simple Repeater: Extends network coverage by relaying messages.
39-
* 📡 Companion Radio: For use with an external chat app, over BLE or USB.
40-
* 📡 Room Server: A simple BBS server for shared Posts.
35+
- Install [PlatformIO](https://docs.platformio.org) in [Visual Studio Code](https://code.visualstudio.com).
36+
- Clone and open the MeshCore repository in Visual Studio Code.
37+
- See the example applications you can modify and run:
38+
- [Companion Radio](./examples/companion_radio) - For use with an external chat app, over BLE, USB or WiFi.
39+
- [Simple Repeater](./examples/simple_repeater) - Extends network coverage by relaying messages.
40+
- [Simple Room Server](./examples/simple_room_server) - A simple BBS server for shared Posts.
41+
- [Simple Secure Chat](./examples/simple_secure_chat) - Secure terminal based text communication between devices.
42+
43+
The Simple Secure Chat example can be interacted with through the Serial Monitor in Visual Studio Code, or with a Serial USB Terminal on Android.
4144

4245
## ⚡️ MeshCore Flasher
4346

0 commit comments

Comments
 (0)