Skip to content

Commit b16f101

Browse files
authored
Add more info to readme
1 parent f29e017 commit b16f101

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
# Esp8266 Developer Tool
44

5-
Is a tool that help you develop code for esp8266
5+
`Esp8266 Developer Tool` Is an electron app that help you develop code for esp8266
6+
Built to allow simple development for simple api applications for esp8266 or any
7+
other controller that can support wireless communication.
8+
9+
*The app are follows the KISS principle (keep it simple, stupid)*
610

711
# install
812

@@ -13,7 +17,7 @@ npm i
1317
npm start
1418
```
1519

16-
compile the code from `/Esp8266/` dir and upload it to your Esp8266, I recommend using the `Arduino IDE` to compile and upload
20+
compile the code from `/Esp8266/` dir and upload it to your Esp8266, I recommend using the `Arduino IDE` to compile and upload.
1721

1822
# usage
1923

@@ -25,27 +29,38 @@ You can use the keyboard Numpad and arrows to input the address.
2529

2630
## how to use
2731

32+
### Opening Page and menu
33+
After skip connecting, your enters the menu and have the following options :
34+
35+
### Debug panel :
2836
You have 7 functions on the debug panel:
2937

30-
- send: send a string to the esp8266 and print result
31-
- auto scroll: scroll automatically to the end of the log
32-
- edit macros: give you the option to edit macros
33-
- five macros buttons: macro is a const string that you can reuse instead of retyping every time
34-
- clear : clear dialogue from screen
35-
- logfile : save the log file of your esp8266 communication
36-
- exit : disconnect esp8266
38+
- send: send a string to the esp8266 and print result.
39+
- auto scroll: scroll automatically to the end of the log.
40+
- edit macros: give you the option to edit macros.
41+
- five macros buttons: macro is a const string that you can reuse instead of retyping every time.
42+
- clear : clear dialogue from screen.
43+
- logfile : save the log file of your esp8266 communication.
44+
- exit : disconnect esp8266.
3745

46+
### Log explorerr panel
3847
You have 2 functions on the log explorerr after open log-file:
3948

40-
- show: Show all log data
41-
- auto scroll: Show the log statistics
49+
- show: Show all log data.
50+
- auto scroll: Show the log statistics.
4251

52+
### Create skeleton code panel
4353
You have 1 function on the Create skeleton code mode:
4454

45-
- save: create code template with leter input in table
46-
- for input : used for api
47-
- retrun: return string for the input that type in "for"
48-
- settings: used for set ssid, wifi password, port and file name
55+
- save: create code template with leter input in table.
56+
- for input : used for api.
57+
- retrun: return string for the input that type in "for".
58+
- settings: used for set ssid, wifi password, port and file name.
59+
60+
### After load
61+
After loading the code you can connect with the address and port and start debugging,
62+
without a connection you will not be able to enter the debug panel.
63+
4964

5065
## Screenshots from the app
5166

0 commit comments

Comments
 (0)