license + readme

Author: wez

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Wez Furlong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -82,6 +82,12 @@ input = ["KEY_F8"]
 output = ["KEY_MUTE"]
 ```
 
+* How do I list available input devices?
+  `sudo evremap list-devices`
+
+* How do I list available key codes?
+  `evremap list-keys`
+
 ## Building it
 
 ```
@@ -104,6 +110,12 @@ your system and then install and enable it:
 
 ```
 $ sudo cp evremap.service /usr/lib/systemd/system/
+$ sudo systemctl daemon-reload
 $ sudo systemctl enable evremap.service
 $ sudo systemctl start evremap.service
 ```
+
+## How do I make this execute a command when a key is pressed?
+
+Since the remapper runs as root, it seems like a dangerous idea to have it
+directly trigger commands, so that feature is not implemented.