summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-10-05 21:30:15 +0200
committerhut <hut@lavabit.com>2010-10-05 21:30:15 +0200
commit258a2668e6cdd34351979b8da17c6e66a738996e (patch)
treecd3406c2198daced1f12cb11c4091fa1ed99dd4c /README
parentdc7ee19fc15eee33c948d0ccd6c06df9682c0bf3 (diff)
parentd3bcb234bf5776da7d9b66e73107e906342eeb7d (diff)
downloadranger-258a2668e6cdd34351979b8da17c6e66a738996e.tar.gz
Merge branch 'stable' into preview
Conflicts:
	ranger/shared/settings.py
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 35 insertions, 6 deletions
diff --git a/README b/README
index d92543f7..2b44015e 100644
--- a/README
+++ b/README
@@ -1,13 +1,14 @@
-Ranger v.1.1.1
+Ranger v.1.2.1
 ==============
 
 Ranger is a free console file manager that gives you greater flexibility
 and a good overview of your files without having to leave your *nix console.
 It visualizes the directory tree in two dimensions: the directory hierarchy
 on one, lists of files on the other, with a preview to the right so you know
-where you'll be going.  The default keys are similar to those of Vim, Emacs
-and Midnight Commander, though Ranger is easily controllable with just the
-arrow keys or the mouse.
+where you'll be going.
+
+The default keys are similar to those of Vim, Emacs and Midnight Commander,
+though Ranger is easily controllable with just the arrow keys or the mouse.
 
 The program is written in Python (2.6 or 3.1) and uses curses for the
 text-based user interface.
@@ -19,7 +20,6 @@ About
 * Author:          Roman Zimbelmann  <romanz@lavabit.com>
 * Website:         http://savannah.nongnu.org/projects/ranger
 * License:         GNU General Public License Version 3
-* Version:         1.1.1
 
 * Download URL of the newest stable version:
 http://git.savannah.gnu.org/cgit/ranger.git/snapshot/ranger-stable.tar.gz
@@ -28,6 +28,15 @@ http://git.savannah.gnu.org/cgit/ranger.git/snapshot/ranger-stable.tar.gz
 git clone http://git.sv.gnu.org/r/ranger.git
 
 
+Design Goals
+------------
+
+* An easily maintainable file manager in a high level language
+* A quick way to switch directories and browse the file system
+* Keep it small but useful, do one thing and do it well
+* Console based, with smooth integration into the unix shell
+
+
 Features
 --------
 
@@ -72,10 +81,30 @@ parent directories and to the right there's a preview of the object you're
 pointing at.  Now use the Arrow Keys to navigate, Enter to open a file
 or type Q to quit.
 
-To customize ranger, copy the files from ranger/defaults/ to ~/.ranger/
+To customize ranger, copy the files from ranger/defaults/ to ~/.config/ranger/
 and modify them according to your wishes.
 
 
+Usage Tips
+----------
+
+The author of ranger uses this function (in ~/.bashrc) to start ranger:
+function ranger-cd {
+  before="$(pwd)"
+  python2.6 /the/path/to/ranger/ranger.py --fail-unless-cd "$@" || return 0
+  after="$(grep \^\' ~/.config/ranger/bookmarks | cut -b3-)"
+  if [[ "$before" != "$after" ]]; then
+    cd "$after"
+  fi
+}
+bind '"\C-o":"ranger-cd\C-m"'
+
+This changes the directory after you close ranger and adds the shortcut
+<CTRL-O> for starting ranger.
+
+To change back to the previous directory, you can type: cd -
+
+
 Troubleshooting, Getting Help
 -----------------------------