remove newline

[matrix_esp_thesis] / Readme.md

diff --git a/Readme.md b/Readme.md
index 614808ea8d459067a69e65fc3901e14fca90f079..2049b21da42847e3470607165a2fe1d0f65df3f4 100644 (file)
--- a/Readme.md
+++ b/Readme.md
@@ -7,8 +7,12 @@ Device verification is also supported.
 ## Building\r
 \r
 Building requires a C/C++ compiler and make.\r
 ## Building\r
 \r
 Building requires a C/C++ compiler and make.\r

+\r

 To build the dependencies run `make deps`.\r
 To build the dependencies run `make deps`.\r

+All dependencies are included in this repository.\r
+\r

 To build any of the examples run `make out/examples/<example>`.\r
 To build any of the examples run `make out/examples/<example>`.\r

+\r

 To use the library:\r
 - Add `src/matrix.c` to compilation\r
 - Add either `src/matrix_http_mongoose.c` or `src/matrix_http_esp32.c` to compilation\r
 To use the library:\r
 - Add `src/matrix.c` to compilation\r
 - Add either `src/matrix_http_mongoose.c` or `src/matrix_http_esp32.c` to compilation\r


@@ -18,24 +22,78 @@ To use the library:
 - Add include path `ext/mjson/src/`\r
 - Add include path `ext/mongoose/`\r
 \r
 - Add include path `ext/mjson/src/`\r
 - Add include path `ext/mongoose/`\r
 \r

+To build the example for the ESP32 start an ESP-IDF shell in esp32/esp_project or esp32/esp_project_riscv and run:\r
+- `idf.py build`\r
+- `idf.py flash`\r
+- `idf.py monitor`\r
+\r
+Examples for the ESP32 are in `esp32/esp_project/main`.\r
+There are currently two, SendEncrypted and Verify.\r
+The example can be set in `esp32/esp_project(_risc_v)/main/CMakeLists.txt` as the second argument after SRCS.\r
+\r
+Any code using the library should compile under ESP-IDF if the following code is added at the end of the file:\r
+```c\r
+#include "wifi.h"\r
+\r
+void\r
+app_main(void)\r
+{\r
+    wifi_init(WIFI_SSID, WIFI_PASSWORD);\r
+\r
+    main();\r
+}\r
+```\r
+\r
+To use the library in an ESP-IDF project:\r
+- Add the matrix and olm components (can be found in `esp32/esp_project/components/`)\r
+- Add `wifi.c/.h` (can be found in `esp32/esp_project/main/`)\r
+- Add `SET(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -fpermissive")` to CMakeLists.txt\r
+- Call `wifi_init("<SSID>", "<PASSWORD>")` before initializing the library\r
+\r

 ## Dependencies\r
 [Mongoose](https://github.com/cesanta/mongoose)\r
 ## Dependencies\r
 [Mongoose](https://github.com/cesanta/mongoose)\r

+\r

 [mjson](https://github.com/cesanta/mjson)\r
 [mjson](https://github.com/cesanta/mjson)\r

+\r

 [Olm](https://gitlab.matrix.org/matrix-org/olm)\r
 \r
 ## Examples\r
 \r
 [Olm](https://gitlab.matrix.org/matrix-org/olm)\r
 \r
 ## Examples\r
 \r

-### Sending an encrypted message\r
+### (De)Initialization\r
+```c\r
+MatrixClient * client = (MatrixClient*)malloc(sizeof(MatrixClient));\r
+MatrixClientInit(client);\r
+\r
+MatrixHttpInit(&client->hc, SERVER);\r
+MatrixClientSetUserId(client, USER_ID);\r
+\r
+MatrixClientLoginPassword(client,\r
+    USERNAME,\r
+    PASSWORD,\r
+    DEVICE_NAME);\r
+\r
+MatrixClientDeleteDevice(client);\r
+    \r
+MatrixHttpDeinit(&client->hc);\r

 ```\r
 ```\r

+\r
+### Uploading keys\r
+```c\r
+MatrixClientGenerateOnetimeKeys(client, 10);\r
+MatrixClientUploadOnetimeKeys(client);\r
+MatrixClientUploadDeviceKeys(client);\r
+```\r
+\r
+### Sending an encrypted message\r
+```c\r

 MatrixMegolmOutSession * megolmOutSession;\r
 MatrixClientNewMegolmOutSession(&client,\r
     ROOM_ID,\r
     &megolmOutSession);\r
 MatrixMegolmOutSession * megolmOutSession;\r
 MatrixClientNewMegolmOutSession(&client,\r
     ROOM_ID,\r
     &megolmOutSession);\r

-printf("megolm session id: %.10s... key: %.10s...\n", megolmOutSession->id, megolmOutSession->key);\r

 \r
 MatrixClientShareMegolmOutSession(&client,\r
     USER_ID,\r
 \r
 MatrixClientShareMegolmOutSession(&client,\r
     USER_ID,\r

-    "ULZZOKJBYN",\r
+    DEVICE_ID2,\r

     megolmOutSession);\r
 \r
 MatrixClientSendEventEncrypted(&client,\r
     megolmOutSession);\r
 \r
 MatrixClientSendEventEncrypted(&client,\r


@@ -45,7 +103,7 @@ MatrixClientSendEventEncrypted(&client,
 ```\r
 \r
 ### Verification\r
 ```\r
 \r
 ### Verification\r

-```\r
+```c\r

 // Request an encrypted event to enable verification\r
 STATIC char eventBuffer[1024];\r
 MatrixClientGetRoomEvent(client,\r
 // Request an encrypted event to enable verification\r
 STATIC char eventBuffer[1024];\r
 MatrixClientGetRoomEvent(client,\r


@@ -60,4 +118,4 @@ STATIC char nextBatch[1024];
 while (! client->verified) {\r
     MatrixClientSync(client, syncBuffer, SYNC_BUFFER_SIZE, nextBatch, 1024);\r
 }\r
 while (! client->verified) {\r
     MatrixClientSync(client, syncBuffer, SYNC_BUFFER_SIZE, nextBatch, 1024);\r
 }\r

-```
\ No newline at end of file
+```\r