summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Adrien Schildknecht <adrien+dev@schischi.me>2013-05-02 16:50:52 +0200
committerGravatar Adrien Schildknecht <adrien+dev@schischi.me>2013-05-02 16:50:52 +0200
commit610fd1e7a2724f9f78cafbc957350085b86dacef (patch)
tree5f8ef17d9a19d2ce43cf10522decfa53bdfa3133
parent54c82ee7f71d8160e17ec7c4e1fc60e97fa87853 (diff)
update Readme
-rw-r--r--README.md16
-rw-r--r--TODO11
2 files changed, 9 insertions, 18 deletions
diff --git a/README.md b/README.md
index 61c3292..0be7882 100644
--- a/README.md
+++ b/README.md
@@ -2,30 +2,32 @@ 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.
-How does it works
------------------
+How it works
+------------
Since there is no proper options to get the pid of the currently focused
-windows,
-xcwd first try to read the \_NET\_WM\_PID property. If it fails, it reads the
-\_NET\_WM\_CLASS and compares it to the name of all the processes (it's kind of
-`pidof name`).
+windows, xcwd first try to read the `_NET_WM_PID` property.
+If it fails, it reads the `_NET_WM_CLASS` and compares it to the name of
+all the running processes (it's kind of `pidof name`).
When xcwd has got the PID, it search the deepest child he has, thus avoiding
getting the working directory of the terminal emulator instead of the shell.
Finally it prints the content of `/proc/pid/cwd` on the standard output. If
-xcwd was unable to find the PID, it prints the content of the HOME variable.
+xcwd was unable to find the PID, it prints the content of the `HOME` variable.
Requirements
------------
+- Linux
- libX11-dev
Running xwcd
------------
Simply invoke the 'xcwd' command.
+
You probably want to use it this way:
``urxvt -cd `xcwd` ``
diff --git a/TODO b/TODO
deleted file mode 100644
index 5ba2c5f..0000000
--- a/TODO
+++ /dev/null
@@ -1,11 +0,0 @@
-TODO
-====
-
-Features
---------
-check the WM_CLIENT_MACHINE property
-multi-monitor ?
-
-Bugs
-----
-