2022-12-19 21:54:08 +01:00
|
|
|
# MEOW lib
|
|
|
|
|
|
2023-11-06 22:44:21 +01:00
|
|
|
# Documentation generation
|
|
|
|
|
## required tools
|
|
|
|
|
* protoc
|
|
|
|
|
* protoc-gen-doc
|
|
|
|
|
* protoc-gen-uml
|
|
|
|
|
* go-plantuml
|
|
|
|
|
* plantuml (plantuml command is as shell script : `java -jar /<path-to-plantuml>/plantuml-mit-<version>.jar "$@"`)
|
|
|
|
|
## generation
|
|
|
|
|
run the shell scripts
|
2022-12-19 21:54:08 +01:00
|
|
|
|
2023-11-06 22:44:21 +01:00
|
|
|
cd pb
|
|
|
|
|
./protogen.sh
|
|
|
|
|
|
|
|
|
|
cd doc
|
|
|
|
|
./docgen.sh
|
|
|
|
|
|
|
|
|
|
# Tests
|
2023-02-17 22:29:21 +01:00
|
|
|
|
|
|
|
|
|
2024-02-07 16:08:24 +01:00
|
|
|
# Design notes
|
|
|
|
|
Config is written as a json file
|
|
|
|
|
Identity is stored as an encrypted json file
|
|
|
|
|
Prefered servers (messaging and my contact's messaging) are stored in an encrypted badger db with server url as key
|
|
|
|
|
Received servers are stored in a sqlite db for extensive searches, with storage limits
|
|
|
|
|
Messages are stored in several badger? or sqlite? db per user with send/receive time as key
|
|
|
|
|
|
