refactor: make README, plaintext to render better on git remotes

1 files changed, 35 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..696f459
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+dapp
+
+dapp is a fullscreen TV-style launcher that reads .desktop file paths from stdin or from a config file.
+
+input sources (in order)
+1. stdin, if stdin is piped
+2. $XDG_CONFIG_HOME/dapp.conf
+3. ~/.config/dapp.conf
+
+config format
+- one desktop entry path per line
+- blank lines are ignored
+- lines starting with # are ignored
+(see dapp.conf.example for reference)
+
+arch linux dependencies
+- sudo pacman -S base-devel pkgconf gtk3 glib2
+
+build
+- make
+
+clean
+- make clean
+
+run
+- from config: ./dapp
+- from stdin:
+  printf '%s\n' /usr/share/applications/firefox.desktop /usr/share/applications/org.gnome.Nautilus.desktop | ./dapp
+
+controls
+- Up or k or w: move selection up
+- Down or j or s: move selection down
+- Enter or Space: launch selected app
+- mouse hover: move highlighted selection
+- single left click: launch hovered app
\ No newline at end of file