aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMichael Homer <mwh@mwh.geek.nz>2014-06-20 09:29:08 +1200
committerMichael Homer <mwh@mwh.geek.nz>2014-06-20 09:31:19 +1200
commit1da073923fd749b6db5a9db120603ebd70371c4e (patch)
tree4ca530cdf640efe0be61afaa41daecf5fbfefbd8 /README
parentAdd short options -t and -x (diff)
downloaddragon-1da073923fd749b6db5a9db120603ebd70371c4e.tar.gz
dragon-1da073923fd749b6db5a9db120603ebd70371c4e.tar.bz2
dragon-1da073923fd749b6db5a9db120603ebd70371c4e.zip
Add readme and licence
The readme gives simple usage an installation instructions.
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d50d26c
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+dragon - simple drag-and-drop source/sink for X
+
+Many programs, particularly web applications, expect files to be dragged
+into them now. If you don't habitually use a file manager that is a
+problem. dragon is a lightweight drag-and-drop source for X where you
+can run:
+ dragon file.tar.gz
+to get a window with just that file in it, ready to be dragged where you
+need it.
+
+What if you need to drag into something? Using:
+ dragon --target
+you get a window you can drag files and text into. Dropped items are
+printed to standard output.
+
+If you're only dealing with a single file, either source or sink, use
+the --and-exit option to terminate as soon as one drag-and-drop
+operation is complete.
+
+If you want to keep the files you drag in around for a while, use:
+ dragon --target --keep
+and each file you drop becomes its own draggable button, which you can
+drag elsewhere later.
+
+Installing
+----------
+Just run `make` to compile dragon and get an executable you can run
+immediately or put where you like.
+
+To install, run `make install`, which will put it into ~/.local/bin by
+default. If you want a different destination, run `make
+PREFIX=/path/here install` instead.
+
+dragon requires GTK+ 3 and is distributed under the GNU GPL version 3.
bgstack15