about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-01-25 04:06:31 -0500
committerJune McEnroe <june@causal.agency>2019-01-25 04:06:31 -0500
commit920ea899d7535d8ad821837be8ca95f525a35eaa (patch)
tree5feef8ee9b811c23722acf49d4a107732d3a0fb9 /README
parentAdd Linux.mk (diff)
downloadcatgirl-920ea899d7535d8ad821837be8ca95f525a35eaa.tar.gz
catgirl-920ea899d7535d8ad821837be8ca95f525a35eaa.zip
Add GNU/Linux build instructions
Diffstat (limited to '')
-rw-r--r--README22
1 files changed, 16 insertions, 6 deletions
diff --git a/README b/README
index 6a14ed2..5957c57 100644
--- a/README
+++ b/README
@@ -7,9 +7,10 @@ DESCRIPTION
      catgirl is a curses IRC client originally intended for use over anonymous
      SSH.
 
-     It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD.
+     It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD and
+     GNU/Linux.
 
-   Build
+INSTALL
      On platforms other than FreeBSD, copy the appropriate file to config.mk
      and modify as needed.  The default install PREFIX is ~/.local.
 
@@ -17,6 +18,18 @@ DESCRIPTION
            make
            make install
 
+   Darwin
+     LibreSSL is assumed to be installed with brew(1).  The sandman(1) wrapper
+     is also installed.
+
+   NetBSD
+     LibreSSL is assumed to be installed with pkgsrc(7).  Due to bugs in
+     NetBSD's curses(3) implementation, some of the UI is currently broken.
+
+   GNU/Linux
+     LibreSSL is assumed to be manually installed in /usr/local and is
+     statically linked.
+
 FILES
      chat.h     shared state and function prototypes
      chat.c     command line parsing
@@ -40,7 +53,4 @@ FILES
 SEE ALSO
      catgirl(1), sandman(1)
 
-BUGS
-     The UI is currently broken with NetBSD's curses implementation.
-
-Causal Agency                  December 2, 2018                  Causal Agency
+Causal Agency                  January 25, 2019                  Causal Agency
5030f8ee10bc97ffcf1bf0061a2e6f22c7252a&follow=1'>ui-shared: URL-escape script_nameJohn Keeping 2014-01-12ui-refs: escape HTML chars in author and tagger namesJohn Keeping 2014-01-12filter: pass extra arguments via cgit_open_filterJohn Keeping 2014-01-12ui-snapshot: set unused cgit_filter fields to zeroJohn Keeping 2014-01-12html: remove redundant htmlfd variableJohn Keeping 2014-01-12tests: add Valgrind supportJohn Keeping 2014-01-12cache: don't leave cache_slot fields uninitializedJohn Keeping 2014-01-10filter: split filter functions into their own fileJason A. Donenfeld 2014-01-10filter: make exit status localJason A. Donenfeld 2014-01-10parsing: fix header typoJason A. Donenfeld 2014-01-10cgit.c: Fix comment on bit mask hackLukas Fleischer 2014-01-10cgit.c: Use "else" for mutually exclusive branchesLukas Fleischer 2014-01-10ui-snapshot.c: Do not reinvent suffixcmp()Lukas Fleischer 2014-01-10Refactor cgit_parse_snapshots_mask()Lukas Fleischer 2014-01-10Disallow use of undocumented snapshot delimitersLukas Fleischer 2014-01-10Replace most uses of strncmp() with prefixcmp()Lukas Fleischer 2014-01-09README: Fix dependenciesLukas Fleischer 2014-01-08README: Spelling and formatting fixesLukas Fleischer 2014-01-08Fix UTF-8 with syntax-highlighting.pyPřemysl Janouch 2014-01-08Add a suggestion to the manpagePřemysl Janouch 2014-01-08Fix the example configurationPřemysl Janouch 2014-01-08Fix about-formatting.shPřemysl Janouch 2014-01-08Fix some spelling errorsPřemysl Janouch 2014-01-08filters: highlight.sh: add css comments for highlight 2.6 and 3.8Ferry Huberts