From: Aaron Taylor <ataylor@subgeniuskitty.com>
Date: Wed, 10 Mar 2021 11:09:09 +0000 (-0800)
Subject: Added README.md for greynetic/reference hack.
X-Git-Url: http://git.subgeniuskitty.com/screensavers/.git/commitdiff_plain/0462f4d6b7e6724c60a78faf47fa12ce3ad3e595

Added README.md for greynetic/reference hack.
---

diff --git a/reference/README.md b/reference/README.md
new file mode 100644
index 0000000..3755e89
--- /dev/null
+++ b/reference/README.md
@@ -0,0 +1,33 @@
+Overview
+========
+
+This directory contains `greynetic`, a "hack" or screensaver which is compatible
+with the [xscreensaver](https://www.jwz.org/xscreensaver/) `screenhack`
+framework. As one of the simplest hacks included with xscreensaver, it serves
+as an excellent starting point when writing your own hack.
+
+Also included is a `Makefile` documenting the build commands, an example
+manpage for `greynetic`, and a document named `README.hacking` containing
+instructions for writing your first hack.
+
+
+Status
+======
+
+Complete. Tested on FreeBSD.
+
+
+Instructions
+============
+
+The included `Makefile` includes targets for `make all` to build the hack,
+`make clean` to delete any build detritus, `make run` to execute the hack, and
+`make manpage` to compile and display the hack's manpage.
+
+If you are running on FreeBSD, simply run one of those four commands. Anywhere
+else, edit the `Makefile` to suit your environment per the comments included in
+that file. Note that the `Makefile` assumes a copy of the screenhack library
+source code is located at `../screenhack/` relative to this directory.
+
+To get started hacking on your hack, read `README.hacking` and then dive into
+the `greynetic.c` source code.