commit d6f142adf9f72fac09f1004d5457659c354d838f
parent 775d6828d60c704bf40830b062fd9d2e3d9d58cb
Author: aabacchus <ben@bvnf.space>
Date: Tue, 29 Nov 2022 18:54:48 +0000
add README
Diffstat:
| A | README | | | 36 | ++++++++++++++++++++++++++++++++++++ |
1 file changed, 36 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,36 @@
+sxirc
+=====
+
+libsx [1] is a library which sits on top of libXaw, the Athena widget
+toolkit, to provide a more simple and user-friendly interface. This IRC
+client is a simple project for me to test libsx with.
+
+[1]: https://web.physics.wustl.edu/marty/libsx/libsx.html
+
+If you're using a distro with a KISS-compatible package manager, I have
+it packaged at https://git.bvnf.space/kiss-repo/.
+
+In particular, I'm looking at how the boundaries of libsx can be worked
+around and used in parallel to the usual Athena and Xt functions.
+
+Usage
+-----
+
+Don't. Just read it.
+
+Or, if you really want to:
+
+Currently, the IRC server, port, and user nick are hard-coded in the
+setup_irc function. Change these, run `make` (assuming you've installed
+libsx), and run the executable. Then, you're typing directly into a
+socket to the server, so you'll need to speak IRC:
+
+ - `NICK mynick`
+ - `PONG :magic` in reply to `PING :magic` to not be kicked off for timing out
+ - `JOIN #channel`
+ - `PRIVMSG #channel :my message`
+
+Comments, feedback
+------------------
+
+Yes please! Contact info is on my homepage at https://bvnf.space/.
