diff options
| author | metamuffin <yvchraiqi@protonmail.com> | 2022-08-17 20:51:09 +0200 |
|---|---|---|
| committer | metamuffin <yvchraiqi@protonmail.com> | 2022-08-17 20:51:09 +0200 |
| commit | e87219d47764f82d073f464a23aa18a6f7d0c9d3 (patch) | |
| tree | e90f13a9d15072f6bb268a76b5402222db232c23 | |
| parent | 136b93291ce3e14b1f38364b467adb764d0eb792 (diff) | |
| download | karlender-e87219d47764f82d073f464a23aa18a6f7d0c9d3.tar karlender-e87219d47764f82d073f464a23aa18a6f7d0c9d3.tar.bz2 karlender-e87219d47764f82d073f464a23aa18a6f7d0c9d3.tar.zst | |
expand readme
| -rw-r--r-- | readme.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -9,6 +9,14 @@ A bloated calender software. - blazing fast and highly configurable 🚀🚀 - undocumented +## Components + +- `karld` daemon process calculating occurences and scheduling +- `karlc` cli-interface for karld (uses unix domain socket) +- `karlgui` graphical user interface made with egui (uses the unix domain socket too) +- `karlcommon` rust library for shared e.g. protocol +- _`????`_ browser interface (future, will use websocket) + ## Protocol Packets with JSON-serialized instances of either `ServerboundPacket` or `ClientboundPacket` respectively as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)) are sent over one of the supported methods. @@ -20,3 +28,7 @@ Every line is a packet. Default location for the socket is `/run/user/<uid>/karl ### Websocket Packets are text messages. Default bind address is `127.0.0.1:18752`. + +## Licence + +GNU Affero General Public License Version 3 only. See [COPYING](./COPYING) |