Added missing newline in NEDsim error message.
[screensavers] / screenhack / README.md
CommitLineData
16714f97
AT
1Overview
2========
3
4The files in this directory comprise the `screenhack` API/library which is part
5of [xscreensaver](https://www.jwz.org/xscreensaver/). They are collected here
6in order to facilitate building the hacks contained in this repository without
7requiring an xscreensaver source tree and build system.
8
9
10Status
11======
12
13All files were extracted from the `xscreensaver-5.45.tar.gz` source tarball and
14remain unmodified.
15
16Since this directory only contains the files related to building X11 hacks
17utilizing the `screenhack` API, if you need the `xlockmore` API or OpenGL
18related files, either build your hack inside the xscreensaver source tree or
19copy the relevant files into this directory; the various makefiles are
20configured to automatically detect and compile them.
21
22
23Instructions
24============
25
26For an example of use, see the top-level directory `reference/` in this
27repository. It contains the `greynetic` hack, already configured to build
28against this `screenhack` library, as well as `README.hacking`, a guide to
29writing hacks against the `screenhack` library.
30
31Although all the hacks in this repo contain `#define`s hardcoded for FreeBSD,
32since all the `screenhack` files are unmodified, they all contain the various
33preprocessor trickery for building on other platforms. If you're having trouble
34figuring out the correct set of `#define`s for building on your system, try
35extracting the xscreensaver source, running `./configure`, and examining the
36`#define`s contained in the generated `config.h`.