add README

1 files changed, 34 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2d3c969
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+README for jsmond
+-----------------
+
+jsmond lets you play games with your joysticks/gamepads without
+xscreensaver activating due to lack of keyboard/mouse input.
+
+Multiple joystick devices can be monitored. By default, jsmond
+monitors up to 16 devices, named /dev/input/js0 through js15.
+These devices don't have to actually exist: they can come and go
+as joysticks are plugged in and unplugged.
+
+Currently jsmond only runs on Linux.
+
+To build, just run make. You'll need a C compiler (gcc or clang)
+and headers/libraries for glibc and Xorg.
+
+To install, "make install". See the top of the Makefile for some useful
+variables you can set to control where things get installed to.
+
+jsmond is released under the terms of the WTFPL:
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.