1 README.portable
2 ===============
3 
4 **NOTE: This repository is read-only and is used only to mirror the
5 got-portable repository for CI purposes.**
6 
7 This is the portable version of got[1] (Game of Trees), using autotools to
8 provide the library checks required for Got's dependencies.
9 
10 Currently this has only been tested on Linux and FreeBSD, although the BSDs
11 are already packaging Got via ports so this isn't a core focus of this
12 portable repository, but patches to improve portability across systems are
13 welcomed.
14 
15 DEPENDENCIES
16 ============
17 
18 Got requires the following dependencies:
19 
20 * `libncurses` (for tog(1))
21 * `libmd` (BSD's digest routines)
22 * `libcrypto` (often via 'libssl-dev' for SHA1 routines)
23 * `libuuid` (for UUID generation)
24 * `libz` (for Z compression)
25 * `pkg-config` (for searching libraries)
26 
27 TESTS (REGRESS)
28 ===============
29 
30 There are tests under regress/ -- these are designed to work on OpenBSD.  For
31 now, the cmdline/ tests have been prioritised.
32 
33 To run the test suite:
34 
35 ```
36  $ make tests
37 ```
38 
39 NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
40        HELPERS ARE HARD-CODED INTO THE BINARIES.
41 
42 INSTALLATION
43 ============
44 
45 ```
46  $ ./autogen.sh
47  $ ./configure && make
48  $ sudo make install
49 ```
50 
51 BRANCHES + SUBMITTING PATCHES
52 =============================
53 
54 `got-portable` has two key branches:
55 
56 * `main` which tracks got upstream untainted.
57 * `linux` which provides the portable version of GoT based from code on `main`
58 
59 Patches for portable code fixes should be based from the `linux` branch and
60 sent to the mailing list for review [2] or sent to me directly (see CONTACT).
61 
62 The read-only Github repository also runs CI checks using Cirrus-CI on Linux
63 and FreeBSD.
64 
65 TODO
66 ====
67 
68 This port is incomplete in that only got(1) and tog(1) have been ported.
69 gotweb has yet to be ported.
70 
71 configure.ac should start defining AC_ENABLE arguments to allow for
72 finer-grained control of where to search for includes/libraries, etc.
73 
74 CONTACT
75 =======
76 
77 Thomas Adam <thomas@xteddy.org>
78 thomas_adam (#gameoftrees on irc.libera.chat)
79 
80 [1]  https://gameoftrees.org
81 [2]  https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees