PHAROS by Ben Collver <bencollver@tilde.pink>
=============================================

* Description
* Requirements
* Configuration
* Installation

Description
===========

Pharos is a gopher front-end to the Internet Archive written in AWK.
It is named after the light-house island near Alexandria.

Requirements
============

* Runs under the Gophernicus gopher server.
  <gopher://gopher.gophernicus.org/>
* Written in AWK.  Tested using busybox awk.
* Commands used:
  * env, mktemp, rm, strings, xargs
  * curl <https://curl.se/>
  * json2tsv <gopher://codemadness.org/1/phlog/json2tsv/>
  * webdump <gopher://codemadness.org/1/phlog/webdump/>

Configuration
=============

To set configuration variables, edit config.m4

AWK_EXT allows use of non-standard features in gawk and mawk
CACHE_ENABLED caches content in sqlite to reduce API calls

Installation
============

Installation depends on m4.  I use m4 to achieve a portable module
system in any major awk.  Gawk has @include() but that isn't
portable.  The make.sh script process the source code and generates
the CGI files based on the settings in config.m4.

    $ sh clean.sh
    $ sh make.sh

Copy cgi/* into the CGI directory.
Copy gopher/* into a gopher directory.

This separation between CGI and gophermaps is necessary because
dynamic gophermaps not binary-safe in gophernicus.