summary refs log tree commit diff
path: root/README.7
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 /README.7
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
09-16 09:34:37 -0400'>2021-09-16Fix /* **/ comment matchingJune McEnroe 2021-09-15Remove typer, add downgrade to READMEJune McEnroe 2021-09-15Set bot mode on downgradeJune McEnroe 2021-09-15Enter capsicum in downgradeJune McEnroe 2021-09-15Factor out common parts of downgrade messagesJune McEnroe 2021-09-14Add downgrade IRC botJune McEnroe 2021-09-14Sort by title if authors matchJune McEnroe 2021-09-13Swap-remove tags as they're foundJune McEnroe 2021-09-12Replace htagml regex with strncmpJune McEnroe 2021-09-11Also defer printing comment for lone close-parensJune McEnroe 2021-09-10Publish "git-comment"June McEnroe 2021-09-10Add git comment --pretty optionJune McEnroe 2021-09-08Defer printing comment if line is blank or closing braceJune McEnroe 2021-09-08Up default min-repeat to 30 linesJune McEnroe 2021-09-08Handle dirty lines in git-commentJune McEnroe 2021-09-08Document and install git-commentJune McEnroe 2021-09-08Add repeat and all options to git-commentJune McEnroe 2021-09-08Add group threshold to git-commentJune McEnroe