aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author3ricsonn <68168688+3ricsonn@users.noreply.github.com>2021-07-24 15:15:12 +0200
committerGitHub <noreply@github.com>2021-07-24 15:15:12 +0200
commit2b7416c9a04e6b5589ee2e3153e7d6325c045bdc (patch)
treeb4e8c8be614b0b6be285aadc2b7af9c352aba224 /README.md
parentcfaedf2e5c8a66f6a58b3b9f2cf58c439bd6f476 (diff)
Added and improved descriptions
Besides an extra description to uninstall the program, I tried to make the usage description a little clearer as it was a bit confusing from my point of view.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index 8c71a16..28cbeb6 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,26 @@ sudo make install
make clean
```
+### Uninstalling
+
+```
+cd /path/to/xwinwrap
+make
+sudo make uninstall
+make clean
+cd ..
+rm -r xwinwrap
+```
+
### Usage
```
-Usage: xwinwrap [-g {w}x{h}+{x}+{y}] [-ni] [-argb] [-fdt]
- [-fs] [-un] [-s] [-st] [-sp] [-a] [-b] [-nf] [-o OPACITY]
- [-sh SHAPE] [-ov] [-ovr] [-d] [-debug] -- COMMAND ARG1...
+Usage:
+ xwinwrap [OPTIONS...] -- <video-player> [VIDEO-PLAYER OPTIONS...] <video-file>
+
Options:
- -g - Specify Geometry (w=width, h=height, x=x-coord,
+ -g {w}x{h}+{x}+{y}
+ - Specify Geometry (w=width, h=height, x=x-coord,
y=y-coord. ex: -g 640x480+100+100)
-ni - Ignore Input
-argb - RGB