Skip to content

Commit 605d041

Browse files
committed
2 parents 2bc26d8 + c3388ef commit 605d041

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,29 @@ Installation
1313

1414
Install ESP-IDF sdk using instructions from https://docs.espressif.com/projects/esp-idf/en/latest/get-started/.
1515

16-
Unzip this project under esp-idf/components folder. Or if you are cloning the repository at https://github.com/espressif/esp-idf, add this repository as submodule using `git submodule add https://github.com/siara-cc/esp32-idf-sqlite3 components/esp32-idf-sqlite3`.
16+
Unzip this project under esp-idf/components folder. Or if you are cloning the repository at https://github.com/espressif/esp-idf, add this repository as submodule using:
17+
18+
`git submodule add https://github.com/siara-cc/esp32-idf-sqlite3 components/esp32-idf-sqlite3`.
19+
20+
Using examples
21+
--------------
22+
23+
1. Download [esp-idf-v3.1.1.zip](https://github.com/espressif/esp-idf/releases/download/v3.1.1/esp-idf-v3.1.1.zip) that includes submodules and unzip
24+
2. `cd esp-idf-v3.1.1`, set path to `xtensa-esp32-elf/bin` and set `IDF_PATH`
25+
3. `git submodule add https://github.com/siara-cc/esp32-idf-sqlite3 components/esp32-idf-sqlite3`
26+
4. `git submodule add https://github.com/siara-cc/esp32-idf-sqlite3-examples examples/esp32-idf-sqlite3-examples`
27+
5. `cd examples/esp32-idf-sqlite3-examples/spiffs`
28+
6. `make flash`
29+
7. To check output, use `miniterm.py <device> 115200` and reset board
1730

1831
Information specific to ESP-IDF
1932
-------------------------------
2033

21-
To check out how this library works, please try the examples (`git submodule add https://github.com/siara-cc/esp32-idf-sqlite3-examples examples/esp32-idf-sqlite3-examples`). For instance, to check how Sqlite3 databases can be created on SPIFFS, naviate to the folder `examples/esp32-idf-sqlite3-examples/spiffs` and invoke `make flash`.
34+
To check out how this library works, please try the examples using:
35+
36+
`git submodule add https://github.com/siara-cc/esp32-idf-sqlite3-examples examples/esp32-idf-sqlite3-examples`
37+
38+
For instance, to check how Sqlite3 databases can be created on SPIFFS, naviate to the folder `examples/esp32-idf-sqlite3-examples/spiffs` and invoke `make flash`.
2239

2340
Many configurations specific to SQLite library have been set in the `sdkconfig` file, such as:
2441

0 commit comments

Comments
 (0)