Skip to content

Commit 22f0577

Browse files
authored
Update README.md
Add exception decoder and fix layout
1 parent b5858c1 commit 22f0577

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

+17-7
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
## Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44

55
- [Development Status](#development-status)
6-
- Installing options:
7-
+ [Using Arduino IDE](#using-arduino-ide)
6+
- [Installation Instructions](#installation-instructions):
7+
+ [Using Arduino IDE](#using-through-arduino-ide)
8+
+ [Windows](https://github.com/espressif/arduino-esp32/blob/master/doc/windows.md)
9+
+ [Mac OS](#instructions-for-mac)
10+
+ [Debian/Ubuntu](#instructions-for-debianubuntu-linux)
11+
+ [Decoding Exceptions](#decoding-exceptions)
812
+ [Using PlatformIO](#using-platformio)
913
+ [Using as ESP-IDF component](#using-as-esp-idf-component)
1014
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
@@ -15,11 +19,13 @@ Most of the framework is implemented. Most noticable is the missing analogWrite.
1519
- 8 channels [SigmaDelta](https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-sd.h) which uses SigmaDelta modulation
1620
- 2 channels [DAC](https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-dac.h) which gives real analog output
1721

18-
## Using Arduino IDE
22+
## Installation Instructions
23+
24+
### Using through Arduino IDE
1925

2026
###[Instructions for Windows](doc/windows.md)
2127

22-
### Instructions for Mac
28+
#### Instructions for Mac
2329
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
2430
- Open Terminal and execute the following command (copy->paste and hit enter):
2531

@@ -35,7 +41,7 @@ Most of the framework is implemented. Most noticable is the missing analogWrite.
3541
```
3642
- Restart Arduino IDE
3743

38-
### Instructions for Debian/Ubuntu Linux
44+
#### Instructions for Debian/Ubuntu Linux
3945
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
4046
- Open Terminal and execute the following command (copy->paste and hit enter):
4147

@@ -53,7 +59,11 @@ Most of the framework is implemented. Most noticable is the missing analogWrite.
5359
```
5460
- Restart Arduino IDE
5561

56-
## Using PlatformIO
62+
#### Decoding exceptions
63+
64+
You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.
65+
66+
### Using PlatformIO
5767

5868
[PlatformIO](http://platformio.org) is an open source ecosystem for IoT
5969
development with cross platform build system, library manager and full support
@@ -67,7 +77,7 @@ Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
6777
Cloud9, Codeanywehre, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM and Visual Studio
6878
- [Project Examples](https://github.com/platformio/platform-espressif32/tree/develop/examples)
6979

70-
## Using as ESP-IDF component
80+
### Using as ESP-IDF component
7181
- Download and install [esp-idf](https://github.com/espressif/esp-idf)
7282
- Create blank idf project (from one of the examples)
7383
- in the project folder, create a folder called components and clone this repository inside

0 commit comments

Comments
 (0)