about 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
'nohover-highlight'> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15Fix doc-related glitches in Makefile and .gitignoreLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15ui-snapshot: avoid segfault when no filename is specifiedLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15fix segfault when displaying empty blobsEric Wong When size is zero, subtracting one from it turns it into ULONG_MAX which causes an out-of-bounds access on buf. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-19Add support for HEAD requestsLars Hjemli This is a quick 'n dirty hack which makes cgit honor HEAD requests. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-19Add support for ETag in 'plain' viewLars Hjemli When downloading a blob identified by its path, the client might want to know if the blob has been modified since a previous download of the same path. To this end, an ETag containing the blob SHA1 seems to be ideal. Todo: add support for HEAD requests... Suggested-by: Owen Taylor <otaylor@redhat.com> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-12ui-tree: escape ascii-text properly in hexdump viewLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-12Makefile: add doc-related targetsLars Hjemli