summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-02-11 02:41:20 -0500
committerJune McEnroe <june@causal.agency>2020-02-11 02:41:20 -0500
commit1bb60065c36c97d9dcad853c0c79a836ceed24e3 (patch)
tree2747c6ef852ddd8bfbafdac04c760a19c2640fad
parentAdd README (diff)
downloadcatgirl-1bb60065c36c97d9dcad853c0c79a836ceed24e3.tar.gz
catgirl-1bb60065c36c97d9dcad853c0c79a836ceed24e3.zip
Add INSTALLING section to README
Diffstat (limited to '')
-rw-r--r--README.720
1 files changed, 18 insertions, 2 deletions
diff --git a/README.7 b/README.7
index fd3b030..1478722 100644
--- a/README.7
+++ b/README.7
@@ -7,8 +7,8 @@
 .Nd IRC client
 .
 .Sh DESCRIPTION
-.Nm
-is a TLS-only curses IRC client.
+.Xr catgirl 1
+is a TLS-only terminal IRC client.
 .
 .Ss Notable Features
 .Bl -bullet
@@ -72,6 +72,22 @@ TLS is now ubiquitous
 and certificates are easy to obtain.
 .El
 .
+.Sh INSTALLING
+.Nm
+requires LibreSSL
+.Pq Fl ltls
+and ncurses
+.Pq Fl lncursesw .
+It primarily targets
+.Fx
+and macOS,
+as well as Linux.
+.Bd -literal -offset indent
+\&./configure
+make all
+sudo make install PREFIX=/usr/local
+.Ed
+.
 .Sh FILES
 .Bl -tag -width "complete.c" -compact
 .It Pa chat.h
d/> I figure there should be some way to scroll without keypad, and apparently this is what emacs offers... 2020-02-12Allow for arguments to open/copy utilitiesJune McEnroe 2020-02-12Handle RPL_AWAYJune McEnroe 2020-02-11Support monochromatic terminalsJune McEnroe Oops, division by zero! 2020-02-11Add .gz to chroot-man scriptJune McEnroe 2020-02-11Add -R restricted flagJune McEnroe 2020-02-11Add chroot targetJune McEnroe 2020-02-11Exit focus and paste modes on err exitJune McEnroe 2020-02-11Add startup GPLv3 note and URLJune McEnroe I am a degenerate. 2020-02-11Make sure -D_GNU_SOURCE ends up in CFLAGS on LinuxJune McEnroe 2020-02-11Add note about setting PKG_CONFIG_PATHJune McEnroe 2020-02-11Rename query ID on nick changeJune McEnroe 2020-02-11Call completeClear when closing a windowJune McEnroe 2020-02-11Don't insert color codes for non-mentionsJune McEnroe 2020-02-11Take first two words in colorMentionsJune McEnroe This lets phrases like "hi june" get colored, but still doesn't get carried away. 2020-02-11Use time_t for save signatureJune McEnroe It's actually more likely to be 64-bit than size_t anyway, and it eliminates some helper functions. Also don't error when reading an empty save file. 2020-02-11Set self.nick to * initiallyJune McEnroe Allows removing a bunch of checks that self.nick is set, and it's what the server usually calls you before registration. Never highlight notices as mentions. 2020-02-11Define ColorCap instead of hardcoding 100June McEnroe 2020-02-11Move hash to top of chat.hJune McEnroe 2020-02-11Move base64 out of chat.hJune McEnroe 2020-02-11Move XDG_SUBDIR out of chat.hJune McEnroe 2020-02-11Fix whois idle unit calculationJune McEnroe Rookie mistake. 2020-02-11Cast towupper to wchar_tJune McEnroe For some reason it takes and returns wint_t... 2020-02-11Cast set but unused variables to voidJune McEnroe 2020-02-11Declare strlcatJune McEnroe 2020-02-11Check if VDSUSP existsJune McEnroe 2020-02-11Fix completeReplace iterationJune McEnroe 2020-02-11Use pkg(8) to configure on FreeBSDJune McEnroe 2020-02-11Remove legacy codeJune McEnroe 2020-02-11Add INSTALLING section to READMEJune McEnroe