Skip to content

Commit b737777

Browse files
author
Me No Dev
committed
Update README
1 parent 20a5709 commit b737777

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@
33
Arduino plugin which lets you get a more meaningful explanation of the stack traces you get on ESP8266 or ESP32.
44

55

6+
## Installation
7+
- Make sure you use one of the supported versions of Arduino IDE and have ESP8266 or ESP31B core installed.
8+
- Download the tool archive from [releases page](https://github.com/me-no-dev/EspExceptionDecoder/releases/latest).
9+
- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet.
10+
- Unpack the tool into tools directory (the path will look like `<home_dir>/Arduino/tools/EspExceptionDecoder/tool/EspExceptionDecoder.jar)`.
11+
- Restart Arduino IDE.
12+
13+
## Usage
14+
- Open a sketch and build it.
15+
- Upload the sketch and monitor the Serial port for Exceptions
16+
- When you get an Exception, open *Tools > ESP Exception Decoder* menu item. This will open a new window.
17+
- Paste the stack trace into the window's top pane and the result will show in the bottom.
18+
- Every time you enter new address or stack trace, the results will refresh
19+
20+
621
## Credits and license
722

823
- Copyright (c) 2015 Hristo Gochkov (ficeto at ficeto dot com)

0 commit comments

Comments
 (0)