Browse Source

Add GNU/Linux build instructions

June 3 weeks ago
parent
commit
920ea899d7
Signed by: Curtis McEnroe <june@causal.agency> GPG Key ID: CEA2F97ADCFCD77C
2 changed files with 43 additions and 15 deletions
  1. 16
    6
      README
  2. 27
    9
      catgirl.7

+ 16
- 6
README View File

@@ -7,9 +7,10 @@ DESCRIPTION
7 7
      catgirl is a curses IRC client originally intended for use over anonymous
8 8
      SSH.
9 9
 
10
-     It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD.
10
+     It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD and
11
+     GNU/Linux.
11 12
 
12
-   Build
13
+INSTALL
13 14
      On platforms other than FreeBSD, copy the appropriate file to config.mk
14 15
      and modify as needed.  The default install PREFIX is ~/.local.
15 16
 
@@ -17,6 +18,18 @@ DESCRIPTION
17 18
            make
18 19
            make install
19 20
 
21
+   Darwin
22
+     LibreSSL is assumed to be installed with brew(1).  The sandman(1) wrapper
23
+     is also installed.
24
+
25
+   NetBSD
26
+     LibreSSL is assumed to be installed with pkgsrc(7).  Due to bugs in
27
+     NetBSD's curses(3) implementation, some of the UI is currently broken.
28
+
29
+   GNU/Linux
30
+     LibreSSL is assumed to be manually installed in /usr/local and is
31
+     statically linked.
32
+
20 33
 FILES
21 34
      chat.h     shared state and function prototypes
22 35
      chat.c     command line parsing
@@ -40,7 +53,4 @@ FILES
40 53
 SEE ALSO
41 54
      catgirl(1), sandman(1)
42 55
 
43
-BUGS
44
-     The UI is currently broken with NetBSD's curses implementation.
45
-
46
-Causal Agency                  December 2, 2018                  Causal Agency
56
+Causal Agency                  January 25, 2019                  Causal Agency

+ 27
- 9
catgirl.7 View File

@@ -1,4 +1,4 @@
1
-.Dd December 2, 2018
1
+.Dd January 25, 2019
2 2
 .Dt CATGIRL 7
3 3
 .Os "Causal Agency"
4 4
 .
@@ -18,16 +18,18 @@ It requires LibreSSL
18 18
 and targets
19 19
 .Fx ,
20 20
 Darwin,
21
-.Nx .
21
+.Nx
22
+and
23
+GNU/Linux.
22 24
 .
23
-.Ss Build
25
+.Sh INSTALL
24 26
 On platforms other than
25 27
 .Fx ,
26 28
 copy the appropriate file to
27 29
 .Pa config.mk
28 30
 and modify as needed.
29 31
 The default install
30
-.Ev PREFIX
32
+.Va PREFIX
31 33
 is
32 34
 .Pa ~/.local .
33 35
 .
@@ -38,6 +40,27 @@ make
38 40
 make install
39 41
 .Ed
40 42
 .
43
+.Ss Darwin
44
+LibreSSL is assumed to be installed with
45
+.Xr brew 1 .
46
+The
47
+.Xr sandman 1
48
+wrapper is also installed.
49
+.
50
+.Ss NetBSD
51
+LibreSSL is assumed to be installed with
52
+.Xr pkgsrc 7 .
53
+Due to bugs in
54
+.Nx Ap s
55
+.Xr curses 3
56
+implementation,
57
+some of the UI is currently broken.
58
+.
59
+.Ss GNU/Linux
60
+LibreSSL is assumed to be manually installed in
61
+.Pa /usr/local
62
+and is statically linked.
63
+.
41 64
 .Sh FILES
42 65
 .Bl -tag -width sandman.m -compact
43 66
 .It Pa chat.h
@@ -84,8 +107,3 @@ implementation for chroot
84 107
 .Sh SEE ALSO
85 108
 .Xr catgirl 1 ,
86 109
 .Xr sandman 1
87
-.
88
-.Sh BUGS
89
-The UI is currently broken with
90
-.Nx Ap s
91
-curses implementation.

Loading…
Cancel
Save