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
-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
patibilityJune McEnroe Implements a dumb version of readpassphrase that calls getpass and implements funopen in terms of fopencookie. 2019-12-23Handle folded From headersJune McEnroe 2019-12-23Restrict search to plain-text messagesJune McEnroe 2019-12-23Properly support using drill rather than digJune McEnroe Silly drill doesn't have +short, so emulate it by waiting for the ANSWER SECTION and skipping the leading fields. 2019-12-22Document dig requirement in imbox(1)June McEnroe 2019-12-22Add CAVEAT about expecting plain-textJune McEnroe 2019-12-22Quote user, pass and mailboxJune McEnroe 2019-12-22Use sequence numbers rather than UIDsJune McEnroe We aren't doing any expunging or anything across different sessions, so it's safe to just use sequence numbers. 2019-12-22Use EXAMINE rather than SELECTJune McEnroe This is a read-only operation. 2019-12-22Export To and CC headersJune McEnroe 2019-12-22Add missing includeJune McEnroe 2019-12-22Export In-Reply-To headersJune McEnroe 2019-12-21Add git-fetch-email to READMEJune McEnroe 2019-12-21Clarify purpose in READMEJune McEnroe 2019-12-21Add READMEJune McEnroe 2019-12-21Add copyright header to git-fetch-emailJune McEnroe 2019-12-21Add git-fetch-email to SEE ALSO of imboxJune McEnroe 2019-12-21Add git-fetch-email wrapperJune McEnroe 2019-12-21Determine host by SRV lookupJune McEnroe 2019-12-21Clean up remaining codeJune McEnroe 2019-12-21Clean up mboxrd codeJune McEnroe 2019-12-21Convert CRLF to LFJune McEnroe 2019-12-21Implement -CFSTJune McEnroe 2019-12-21Rewrite aspirational manualJune McEnroe 2019-12-21Null-terminate read literalsJune McEnroe