summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Ball <nullspoon@iohq.net>2015-04-09 23:11:02 -0600
committerAaron Ball <nullspoon@iohq.net>2015-04-09 23:11:02 -0600
commit55b5a75fb9fce9f01054cff0c302d02970894937 (patch)
tree12cddf132bb1bf79053a3c685163fda1846c725c
parent6afb0689bef2c3d9e0bd34f81d50b17cfb35b56d (diff)
downloadbin-55b5a75fb9fce9f01054cff0c302d02970894937.tar.gz
bin-55b5a75fb9fce9f01054cff0c302d02970894937.tar.xz
Updated the README with better descriptions
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index c8a4021..20fd8f2 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,25 @@
## Description
-Provides a collection of handy ~/bin scripts
+Provides a collection of handy ~/bin scripts.
* **i3-lock-wrapper**: Wrapper around the i3 window manager lock program,
i3lock. Takes a screenshot of the current screen, blurs and desaturates,
then sets as the lock screen background.
-* **screenshot.sh**: Takes a screenshot from the command line. Useful for i3
- users who set up hotkeys that call scripts.
+* **screenshot.sh**: Takes a three-second-delayed drag select screenshot from
+ the command line. Useful for i3 users who set up hotkeys that call scripts.
-* **share_desktop.sh**: Sets up a readonly passworded vnc session for desktop
- sharing. Serves as a fairly nice replacement for proprietary desktop
- sharing applications.
+* **share_desktop.sh**: Sets up a read-only passworded vnc session for
+ desktop sharing. Configured to allow multiple users to connect. Serves as a
+ fairly nice replacement for proprietary desktop sharing applications.
* **vid_compress**: Compresses the given video to ogv (for now). The original
is not deleted. Useful for when lots of video was taken on a trip and you
- don't want to keep the highest quality uncompressed originals around.
+ don't want to keep the highest quality uncompressed originals around. Does
+ not delete the original (in case you would like to keep it or the ogv is
+ bigger than the original)
* **virtualize**: Uses qemu and libvirt to quickly virtualize a single system
in the foreground. Useful for spinning up quick virtual machines with short
- lives (eg: for testing purposes)
+ lives (eg: for testing purposes). All script arguments are passed through
+ to qemu directly, in case further configuration is desired.

Generated by cgit