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
-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
ommit/home/.config/X/resources?id=0c5cae773081392ea2fb58dcab70d777c45c403d&follow=1'>Use class names for Foreground, Background, BorderColorJune McEnroe I'm not really sure what difference this makes, but it seems like the right thing to do to be generic? 2021-02-07Add simple battery status and clock to xsessionJune McEnroe I love how simple this is. 2021-02-07Set cursor theme and sizeJune McEnroe 2021-02-07Use scrot for up -s if no screencaptureJune McEnroe Still missing putting the URL in an X selection. 2021-02-07Enable mouse acceleration in XJune McEnroe 2021-02-07Set colours for Xt and cwmJune McEnroe And increase XTerm internalBorder. 2021-02-07Set urgency on bell in xtermJune McEnroe 2021-02-07Add bindings for brightness controlJune McEnroe Weirdly the Fn key doesn't change how the F row registers... I wonder if I can do something about that. 2021-02-07Set X key repeat rateJune McEnroe 2021-02-07Bump font size to 12June McEnroe 11 is what I use on macOS, but I feel like my eyes are working harder here. 2021-02-07Fully configure and rebind cwmJune McEnroe This is sort of a mix of trying to emulate macOS somewhat for my muscle memory and just rebinding some of the cwm defaults to use 4- rather than M-. 2021-02-07Add BintiJune McEnroe 2021-02-07Finish configuring xtermJune McEnroe 2021-02-06Enable tapping, reverse scroll, set scaling in wsconsctlJune McEnroe 2021-02-06Set root window to black on purple snowJune McEnroe 2021-02-06Add xmodmap configurationJune McEnroe 2021-02-06Add initial OpenBSD X configurationJune McEnroe cwm still needs a lot more rebinding, and I need to actually look at its other options. xterm definitely still needs some configuration, but I at least managed to get it to use a decent looking font. Very happy that OpenBSD includes Luxi Mono, which is what my usual font, Go Mono, is based on anyway. Still missing is xmodmap and such. 2021-02-06Add xterm output to schemeJune McEnroe