commit 00ced238c405770dc7df7c18bd32ef055ee03793
from: Thomas Adam <thomas@xteddy.org>
date: Fri Sep 24 23:23:56 2021 UTC

README: add for Github mirroring purposes

Add a .github/README.md file so that the read-only clone of GoT on
Github, which is used for CI purposes, explains the project.

Also, update the README.portable vesion to patch.

commit - cdf9da3e2fae83e739d1b49c5843b05b813001b7
commit + 00ced238c405770dc7df7c18bd32ef055ee03793
blob - /dev/null
blob + c7cd78d7e888f4bd92c8215d93f2bf8ac590f79d (mode 644)
--- /dev/null
+++ .github/README.md
@@ -0,0 +1,80 @@
+README.portable
+===============
+
+**NOTE: This repository is read-only and is used only to mirror the
+got-portable repository for CI purposes.**
+
+This is the portable version of got[1] (Game of Trees), using autotools to
+provide the library checks required for Got's dependencies.
+
+Currently this has only been tested on Linux and FreeBSD, although the BSDs
+are already packaging Got via ports so this isn't a core focus of this
+portable repository, but patches to improve portability across systems are
+welcomed.
+
+DEPENDENCIES
+============
+
+Got requires the following dependencies:
+
+* `libncurses` (for tog(1))
+* `libmd` (BSD's digest routines)
+* `libcrypto` (often via 'libssl-dev' for SHA1 routines)
+* `libuuid` (for UUID generation)
+* `libz` (for Z compression)
+* `pkg-config` (for searching libraries)
+
+TESTS (REGRESS)
+===============
+
+There are tests under regress/ -- these are designed to work on OpenBSD.  For
+now, the cmdline/ tests have been prioritised.
+
+To run the test suite:
+
+```
+ $ make tests
+```
+
+NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
+       HELPERS ARE HARD-CODED INTO THE BINARIES.
+
+INSTALLATION
+============
+
+```
+ $ ./autogen.sh
+ $ ./configure && make
+ $ sudo make install
+```
+
+BRANCHES + SUBMITTING PATCHES
+=============================
+
+`got-portable` has two key branches:
+
+* `main` which tracks got upstream untainted.
+* `linux` which provices the portable version of GoT based from code on `main`
+
+Patches for portable code fixes should be based from the `linux` branch and
+sent to the mailing list for review [2] or sent to me directly (see CONTACT).
+
+The read-only Github repository also runs CI checks using Cirrus-CI on Linux
+and FreeBSD.
+
+TODO
+====
+
+This port is incomplete in that only got(1) and tog(1) have been ported.
+gotweb has yet to be ported.
+
+configure.ac should start defining AC_ENABLE arguments to allow for
+finer-grained control of where to search for includes/libraries, etc.
+
+CONTACT
+=======
+
+Thomas Adam <thomas@xteddy.org>
+thomas_adam (#gameoftrees on irc.libera.chat)
+
+[1]  https://gameoftrees.org
blob - 056822aca740cbc068d31ea69ebe699a6e274b3b
blob + 3ffae567b248e69d7d7833c35f9587c3cf76470a
--- README.portable
+++ README.portable
@@ -4,25 +4,23 @@ README.portable
 This is the portable version of got[1] (Game of Trees), using autotools to
 provide the library checks required for Got's dependencies.
 
-Currently this has only been tested on Linux, although in theory this should
-still work on *BSD although the BSDs are already packaging Got via ports so
-this isn't a core focus of this portable repository, but patches to improve
-portability across systems are welcomed.
+Currently this has only been tested on Linux and FreeBSD, although the BSDs
+are already packaging Got via ports so this isn't a core focus of this
+portable repository, but patches to improve portability across systems are
+welcomed.
 
 DEPENDENCIES
 ============
 
-Got requires the following libraries:
+Got requires the following dependencies:
 
-* libncurses (for tog(1))
-* libmd (BSD's digest routines)
-* libcrypto (often via 'libssl-dev' for SHA1 routines)
-* libuuid (for UUID generation)
-* libz (for Z compression)
+* `libncurses` (for tog(1))
+* `libmd` (BSD's digest routines)
+* `libcrypto` (often via 'libssl-dev' for SHA1 routines)
+* `libuuid` (for UUID generation)
+* `libz` (for Z compression)
+* `pkg-config` (for searching libraries)
 
-Currently, these dependencies are searched for via pkg-config(1) which must
-also be installed.
-
 TESTS (REGRESS)
 ===============
 
@@ -31,18 +29,36 @@ now, the cmdline/ tests have been prioritised.
 
 To run the test suite:
 
+```
  $ make tests
+```
 
-NOTE:  THIS ONLY WORKS AFTER 'make install' DUE TO HOW PATHS TO LIBEXEC
+NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
        HELPERS ARE HARD-CODED INTO THE BINARIES.
 
 INSTALLATION
 ============
 
+```
  $ ./autogen.sh
  $ ./configure && make
  $ sudo make install
+```
 
+BRANCHES + SUBMITTING PATCHES
+=============================
+
+`got-portable` has two key branches:
+
+* `main` which tracks got upstream untainted.
+* `linux` which provices the portable version of GoT based from code on `main`
+
+Patches for portable code fixes should be based from the `linux` branch and
+sent to the mailing list for review [2] or sent to me directly (see CONTACT).
+
+The read-only Github repository also runs CI checks using Cirrus-CI on Linux
+and FreeBSD.
+
 TODO
 ====