From 0b302038820b007807920c813f256cc516a06111 Mon Sep 17 00:00:00 2001 From: Aaron Taylor Date: Wed, 10 Mar 2021 03:16:09 -0800 Subject: [PATCH] Added basic README for overall repo. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..28392b8 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +Overview +======== + +This repository contains three things related to writing "hacks", or +screensavers which are compatible with the +[xscreensaver](https://www.jwz.org/xscreensaver/) `screenhack` framework. +They are: + + - a copy of the `screenhack` library, located under the `screenhack/` + directory, allowing the compilation of standalone hacks outside the + xscreensaver build system, + + - reference files needed to build your own hack, including a simple yet + complete reference implementation as well as notes for getting started, all + located under the `reference/` directory, and + + - a collection of my own hacks located under the `hacks/` directory. + +Each of the three subdirectories includes a `README.md` file explaining how to +use its contents. + + +Status +====== + +Complete. Tested on FreeBSD. + -- 2.20.1