From: Patrick <patrick.schoenberger@posteo.de>
Date: Mon, 13 Nov 2023 21:54:42 +0000 (+0100)
Subject: Readme
X-Git-Url: https://gitweb.ps.run/matrix_esp_thesis/commitdiff_plain/948d30fa138bd6c3eef75a234c90fa5843057d4b?ds=sidebyside

Readme
---

diff --git a/Readme.md b/Readme.md
index c4e575b..f75f65e 100644
--- a/Readme.md
+++ b/Readme.md
@@ -9,6 +9,7 @@ Device verification is also supported.
 Building requires a C/C++ compiler and make.
 
 To build the dependencies run `make deps`.
+All dependencies are included in this repository.
 
 To build any of the examples run `make out/examples/<example>`.
 
@@ -21,6 +22,17 @@ To use the library:
 - Add include path `ext/mjson/src/`
 - Add include path `ext/mongoose/`
 
+To build the example for the ESP32 start an ESP-IDF shell in esp32/esp_project or esp32/esp_project_riscv and run:
+- `idf.py build`
+- `idf.py flash`
+- `idf.py monitor`
+
+To use the library in an ESP-IDF project:
+- Add the matrix and olm components (can be found in `esp32/esp_project/components/`)
+- Add `wifi.c/.h` (can be found in `esp32/esp_project/main/`)
+- Add `SET(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -fpermissive")` to CMakeLists.txt
+- Call `wifi_init("<SSID>", "<PASSWORD>")` before initializing the library
+
 ## Dependencies
 [Mongoose](https://github.com/cesanta/mongoose)