initial commit

1 files changed, 67 insertions, 0 deletions

diff --git a/README.ans b/README.ans
new file mode 100644
index 0000000..932f2f4
--- /dev/null
+++ b/README.ans
@@ -0,0 +1,67 @@
+
+                               ..
+                              .$$S.             .,.
+                              .S$$$$;     .,,,,,,,.
+                                ;$$$$. .,,;;,,,,.
+                                   ;S;,;;,,.
+                                   .;;,;,
+                                   ,s, s$;
+                                   .,.;$$S
+                                    .s$$$,
+                                  .;S$$$;.
+                                  s$s;. ,;.
+                               .;S$$S   .,;,.
+                              .s$S;.     .,;;.
+.;sS$S;.                     ,$$s.         .;;.                  .,S$;.
+.;sS$$$$$$$s,.              ,$$S.           .;;.            .;S$SSS$$;.
+    .;S$$$$$$$$$Ss;.       ,$$$.             .;,        s$$$$$$$Ss;,.
+          ,sS$$$$$$$$$Ss;,.,s;.               ,,  ,$$$$$$$$$$S;.
+               .,;S$$$$$$$$$$$S,           .sSSSsS$$$$$$$;
+                     .,;s$$$$$$$,          .S$$$SS$$,
+                          .;;,sS,           .,ss,.,,,.
+                     .,,,,s$$s.             ..,;..,,;;,,,,,.
+           .,,,,,,,,,;;,,,;$$$,             .,;;.   .,,,,,;;,,,,,.
+   .,,,,,,,;;,,,,,,,,,.    .s$$.           .,;;.          .,,,,,;;,,,,.
+ .,;;,,,,,,,.               .$$$s         .;;,.                 .,,,,,.
+ .,,.                        ,$$$$.      .;;.
+                              .$$$$s    .;;.
+                                S$$$.  .;;.
+                                 ;$S,,,,,.
+                                   .;;;,
+                                 .,;;.S$s
+                                .;;,. $$$
+                                .;, .s$$;
+                                 ..,$$$;
+                                 ,s$$$;.
+                               ,S$$$S.,;.
+                              .S$$S,. .;;.
+                              .;;,.    .,.
+
+
+shibari is a program that reads inputs from various devices and
+executes user-specified bindings.
+
+It uses the evdev interface exposed by the Linux kernel, which means
+it can handle keyboards as well as mouse and gamepad buttons and that
+it can function indiferrently of being run in X11, Wayland or in a
+headless setup.
+
+shibari requires read access to files in /dev/input and
+/sys/class/input.
+
+Bindings are specified in a bindings file searched for at, in order of
+preference:
+ - the path given as argument to the "-c" option
+ - $XDG_CONFIG_HOME/shibari/bindings.conf
+ - $HOME/.config/shibari/bindings.conf
+
+The bindings file expects one binding per line of the form:
+
+"<code> <press|release> <cmd>"
+
+where <code> is the key code which can be seen by running shibari with
+the "-t" option, <press|release> specifies wether the binding should
+be run when the key is pressed or released and <cmd> is a command
+string that will be run by /bin/sh when the binding is activated.
+
+Empty lines and anything after a "#" is ignored.