abouttreesummaryrefslogcommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorPatrick2023-11-13 22:48:27 +0100
committerPatrick2023-11-13 22:48:27 +0100
commit344ddb2b73ca1f528ad057bcb0ee54862e0018f0 (patch)
tree19e72f7aff60ccb6e4968f7bafc66de62d978cf0 /Readme.md
parent38913d046a6bac123a5e4a0adc450eb719f4c6e2 (diff)
downloadmatrix_esp_thesis-344ddb2b73ca1f528ad057bcb0ee54862e0018f0.tar.gz
matrix_esp_thesis-344ddb2b73ca1f528ad057bcb0ee54862e0018f0.zip
Readme
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
index 614808e..c4e575b 100644
--- a/Readme.md
+++ b/Readme.md
@@ -7,8 +7,11 @@ Device verification is also supported.
## Building
Building requires a C/C++ compiler and make.
+
To build the dependencies run `make deps`.
+
To build any of the examples run `make out/examples/<example>`.
+
To use the library:
- Add `src/matrix.c` to compilation
- Add either `src/matrix_http_mongoose.c` or `src/matrix_http_esp32.c` to compilation
@@ -20,7 +23,9 @@ To use the library:
## Dependencies
[Mongoose](https://github.com/cesanta/mongoose)
+
[mjson](https://github.com/cesanta/mjson)
+
[Olm](https://gitlab.matrix.org/matrix-org/olm)
## Examples