From cfa631834c54cd25babb59aa298d0c6f44a30caa Mon Sep 17 00:00:00 2001 From: Jaidyn Levesque <10477760+JadedCtrl@users.noreply.github.com> Date: Wed, 15 Feb 2023 00:17:25 -0600 Subject: [PATCH] Add README files --- README.md | 3 +++ bin/README.md | 26 ++++++++++++++++++++++++++ irc-chatd.scm => irc-chatdir.scm | 0 3 files changed, 29 insertions(+) create mode 100644 README.md create mode 100644 bin/README.md rename irc-chatd.scm => irc-chatdir.scm (100%) diff --git a/README.md b/README.md new file mode 100644 index 0000000..67e0841 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# irc-chatdir + +WIP IRC client whose interface is a file hierarchy; similar to `ii`, in a way. diff --git a/bin/README.md b/bin/README.md new file mode 100644 index 0000000..24076b6 --- /dev/null +++ b/bin/README.md @@ -0,0 +1,26 @@ +# utils + +Some simple scripts that can make irc-chatdir a friendly option for a client. + +## chatdir-in.sh +Messages are sent, in chatdir, via .in/ directories under each channel's dir. +The file can be named whatever, it just has to be a text-file, and it'll be +sent. But `$ echo "Hi there!" > #general/.in/msg` is annoying. + +This is a wrapper around that. It will send whatever you type to the selected +channel; selecting a channel is done by just typing a channel name verbatim. +There is auto-completion for nicks and channel-names. + +You might run it like, `$ chatdir-in.sh ~/chat/libera.chat/` + + +## irc_file_notify.sh +Sends a pretty notification (with icon, sender, and message text!) whenever a +message is sent. You might run like, `$ irc_file_notify.sh ~/chat/libera.chat/*` + + +## proc_notify.sh +Displays a warning notifcation when irc-chatdir dies. +You might run like, `$ proc_notify.sh irc-chatd.scm.*leagueh` + + diff --git a/irc-chatd.scm b/irc-chatdir.scm similarity index 100% rename from irc-chatd.scm rename to irc-chatdir.scm