Merge remote-tracking branch 'xwintmp/master'

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f120a12
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Xwinwrap
+
+My fork of xwinwrap.  
+Xwinwrap allows you to stick most of the apps to your desktop background.  
+My use case - can use gif as a background
+
+![demo gif](https://github.com/ujjwal96/xwinwrap/blob/demo/demo.gif)
+
+### Installing
+
+```
+sudo apt-get install xorg-dev build-essential libx11-dev x11proto-xext-dev libxrender-dev libxext-dev
+git clone https://github.com/ujjwal96/xwinwrap.git
+cd xwinwrap
+make
+sudo make install
+make clean
+```
+
+### Usage
+
+```
+Usage: xwinwrap [-g {w}x{h}+{x}+{y}] [-ni] [-argb] [-fs] [-s] [-st] [-sp] [-a] [-b] [-nf] [-o OPACITY] [-sh SHAPE] [-ov]-- COMMAND ARG1...
+Options:
+             -g      - Specify Geometry (w=width, h=height, x=x-coord, y=y-coord. ex: -g 640x480+100+100)
+             -ni     - Ignore Input
+             -argb   - RGB
+             -fs     - Full Screen
+             -un     - Undecorated
+             -s      - Sticky
+             -st     - Skip Taskbar
+             -sp     - Skip Pager
+             -a      - Above
+             -b      - Below
+             -nf     - No Focus
+             -o      - Opacity value between 0 to 1 (ex: -o 0.20)
+             -sh     - Shape of window (choose between rectangle, circle or triangle. Default is rectangle)
+             -ov     - Set override_redirect flag (For seamless desktop background integration in non-fullscreenmode)
+             -debug  - Enable debug messages
+```
+Example
+`xwinwrap -g 400x400 -ni -s -nf -b -un -argb -sh circle -- gifview -w WID mygif.gif -a`
+
+### Changes
+
+* Added ability to make undecorated window
+* Changed how desktop window is found
+* Refactored window hints
+
+----
+Original source - https://launchpad.net/xwinwrap