summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4dc509
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+xcwd - X current working directory
+==================================
+xcwd is a simple tool which print the current working directory of the
+currently focused window.
+The main goal is to launch applications directly into the same directory
+as the focused applications. This is especially useful if you want to open
+a new terminal for debugging or compiling purpose.
+
+Requirements
+------------
+- libX11-dev
+
+Running xwcd
+------------
+Simply invoke the 'xcwd' command.
+You probably want to use it this way:
+ ``urxvt -cd `xcwd` ``