aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <yvchraiqi@protonmail.com>2022-08-16 16:16:26 +0200
committermetamuffin <yvchraiqi@protonmail.com>2022-08-16 16:16:26 +0200
commit1b46514ab7c9c54e635fdfc1e561ab14da512537 (patch)
tree0b025c3b3e0720ad4ec6ca70e5f998669523920f
parentea35ce0e6848c1224fa4c1cff424480a2996b49a (diff)
downloadkarlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar
karlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar.bz2
karlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar.zst
doc
-rw-r--r--COPYING2
-rw-r--r--karlcommon/src/lib.rs2
-rw-r--r--readme.md9
3 files changed, 11 insertions, 2 deletions
diff --git a/COPYING b/COPYING
index 42262b3..b659085 100644
--- a/COPYING
+++ b/COPYING
@@ -1,4 +1,4 @@
-karlender (karld, karlc) - bloated calendar daemon
+karlender (karld, karlc, karlgui, libkarlcommon) - bloated calendar daemon
Copyright (C) 2022 metamuffin
This program is free software: you can redistribute it and/or modify
diff --git a/karlcommon/src/lib.rs b/karlcommon/src/lib.rs
index 173beba..f9cd9d4 100644
--- a/karlcommon/src/lib.rs
+++ b/karlcommon/src/lib.rs
@@ -10,7 +10,7 @@ pub fn socket_path() -> PathBuf {
std::env::var("XDG_RUNTIME_DIR")
.map(|p| Path::new(p.as_str()).to_path_buf())
.unwrap_or_else(|_| Path::new("/run/user").join(format!("{}", getuid())))
- .join("calendar")
+ .join("karlender")
}
fn getuid() -> u32 {
std::fs::metadata("/proc/self").unwrap().uid()
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..94c2d53
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# karlender
+
+A bloated calender software.
+
+TODO
+
+## Protocol
+
+Every line sent over the unix domain socket, is a JSON-serialized instance of either `ServerboundPacket` or `ClientboundPacket` as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)). By default the socket is located at `/run/user/<uid>/karlender`