README.portable

   1 README.portable
   2 ===============
   3
   4 This is the portable version of got[1] (Game of Trees), using autotools to
   5 provide the library checks required for GoT's dependencies.
   6
   7 The following operating systems are supported:
   8
   9 * FreeBSD
  10 * NetBSD
  11 * DragonFlyBSD
  12 * MacOS
  13 * Linux
  14
  15 DEPENDENCIES
  16 ============
  17
  18 Linux:
  19
  20 * `libncurses` (for tog(1))
  21 * `libmd` (BSD's digest routines)
  22 * `libbsd` (BSD's arc4random routines)
  23 * `libcrypto` (often via 'libssl-dev' for SHA1 routines)
  24 * `libuuid` (for UUID generation)
  25 * `libz` (for Z compression)
  26 * `pkg-config` (for searching libraries)
  27 * `bison` (for configuration file grammar)
  28
  29 FreeBSD:
  30
  31 * `automake`
  32 * `pkgconf`
  33
  34 NetBSD:
  35
  36 * `automake`
  37 * `libuuid`
  38 * `ncuresesw`
  39
  40 DragonFlyBSD:
  41
  42 * `automake`
  43 * `pkgconf`
  44 * `openssl`
  45
  46 Darwin (MacOS):
  47
  48 * `automake`
  49 * `bison`
  50 * `pkg-config`
  51 * `ncurses`
  52 * `openssl`
  53 * `ossp-uuid`
  54
  55 TESTS (REGRESS)
  56 ===============
  57
  58 To run the test suite:
  59
  60 ```
  61  $ make tests
  62 ```
  63
  64 NOTE: For Linux, you must have the jot(1) command which is typically in the
  65 `athena-jot` package, or similar.
  66
  67 NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
  68        HELPERS ARE HARD-CODED INTO THE BINARIES.
  69
  70 INSTALLATION
  71 ============
  72
  73 ```
  74  $ ./autogen.sh
  75  $ ./configure && make
  76  $ sudo make install
  77 ```
  78
  79 BRANCHES + SUBMITTING PATCHES
  80 =============================
  81
  82 `got-portable` has two key branches:
  83
  84 * `main` which tracks got upstream untainted.
  85 * `linux` which provides the portable version of GoT based from code on `main`
  86
  87 Patches for portable code fixes should be based from the `linux` branch and
  88 sent to the mailing list for review [2] or sent to me directly (see CONTACT).
  89
  90 The read-only Github repository also runs CI checks using Cirrus-CI on Linux
  91 and FreeBSD.
  92
  93 TODO
  94 ====
  95
  96 configure.ac should start defining AC_ENABLE arguments to allow for
  97 finer-grained control of where to search for includes/libraries, etc.
  98
  99 CONTACT
 100 =======
 101
 102 Thomas Adam <thomas@xteddy.org>
 103 thomas_adam (#gameoftrees on irc.libera.chat)
 104
 105 [1]  https://gameoftrees.org
 106 [2]  https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees