projects / screensavers / blame
| Commit | Line | Data |
|---|---|---|
| 0462f4d6 AT |
1 | Overview |
| 2 | ======== | |
| 3 | ||
| 4 | This directory contains `greynetic`, a "hack" or screensaver which is compatible | |
| 5 | with the [xscreensaver](https://www.jwz.org/xscreensaver/) `screenhack` | |
| 6 | framework. As one of the simplest hacks included with xscreensaver, it serves | |
| 7 | as an excellent starting point when writing your own hack. | |
| 8 | ||
| 9 | Also included is a `Makefile` documenting the build commands, an example | |
| 10 | manpage for `greynetic`, and a document named `README.hacking` containing | |
| 11 | instructions for writing your first hack. | |
| 12 | ||
| 13 | ||
| 14 | Status | |
| 15 | ====== | |
| 16 | ||
| 17 | Complete. Tested on FreeBSD. | |
| 18 | ||
| 19 | ||
| 20 | Instructions | |
| 21 | ============ | |
| 22 | ||
| 23 | The included `Makefile` includes targets for `make all` to build the hack, | |
| 24 | `make clean` to delete any build detritus, `make run` to execute the hack, and | |
| 25 | `make manpage` to compile and display the hack's manpage. | |
| 26 | ||
| 27 | If you are running on FreeBSD, simply run one of those four commands. Anywhere | |
| 28 | else, edit the `Makefile` to suit your environment per the comments included in | |
| 29 | that file. Note that the `Makefile` assumes a copy of the screenhack library | |
| 30 | source code is located at `../screenhack/` relative to this directory. | |
| 31 | ||
| 32 | To get started hacking on your hack, read `README.hacking` and then dive into | |
| 33 | the `greynetic.c` source code. |