README

sstoy - Simple ShaderToy viewer for X & GLES2
=============================================
A simple offline ShaderToy-compatible GLSL shader viewer for
X using OpenGL ES 2.0, inspired by the Suckless Philosophy.

Requirements
------------
In order to build sstoy you will need the Xlib, EGL and
OpenGL ES 2.0 development headers installed on your system.
The program can also be demanding on GPU hardware, so the
more powerful GPU you have, the better.

Installation
------------
Edit config.mk to match your local setup (the /usr/local prefix
is used by default).

Afterwards enter the following command to build and install
sstoy (if necessary as root):

    make clean install

Running
-------
Simply invoke the 'sstoy' command. To quit, press either the
Escape or Q keys.