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