[screensavers] / README.md

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.
Commit	Line	Data
0b302038 AT	1	Overview
	2	========
	3
	4	This repository contains three things related to writing "hacks", or
	5	screensavers which are compatible with the
	6	[xscreensaver](https://www.jwz.org/xscreensaver/) `screenhack` framework.
	7	They are:
	8
	9	- a copy of the `screenhack` library, located under the `screenhack/`
	10	directory, allowing the compilation of standalone hacks outside the
	11	xscreensaver build system,
	12
	13	- reference files needed to build your own hack, including a simple yet
	14	complete reference implementation as well as notes for getting started, all
	15	located under the `reference/` directory, and
	16
	17	- a collection of my own hacks located under the `hacks/` directory.
	18
	19	Each of the three subdirectories includes a `README.md` file explaining how to
	20	use its contents.
	21
	22
	23	Status
	24	======
	25
	26	Complete. Tested on FreeBSD.
	27