Permalink
Browse files

Tweak the readme

  • Loading branch information...
1 parent 8a235be commit 08de01433c12755d0ddf154db4a147ca8a55187f @philc committed Apr 11, 2010
Showing with 8 additions and 11 deletions.
  1. +8 −11 README.md
View
19 README.md
@@ -1,32 +1,29 @@
Overview
-========
+--------
fuzzycd enables you to use cd with partial directory names which are fuzzily matched. For example:
$ cd photos/seattle
=> photos/2008-05-28 parasailing in Seattle
- $ cd work/code/playback
- => work/code/player_module_playback
+ $ cd code/player/playback
+ => code/player/player_module_playback
If there is more than one directory that matches your expression, you'll get a menu to choose from.
$ cd photos/christmas
1.photos/2009-12-23 christmas eve party 2.photos/2009-12-24 christmas service
3.photos/2009-12-25 christmas Day
Why?
-====
+----
fuzzycd helps you to be lazy and type just what's necessary to get where you're going. Life is too short to struggle through some of those long, tricky directory names, even with tab completion. If you have directories you navigate to ten times a day and symlinks aren't a workable option, this will save you keystrokes and put a smirk on your face as you effortlessly glide across your filesystem.
Setup
-=====
-Modify your ~/.profile (or ~/.bashrc, depending your operating system) and add the following lines:
+-----
+Modify your ~/.profile (or ~/.bashrc, depending your operating system) and add the following lines. This assumes you put fuzzycd in the ~/scripts/ directory.
- # Add fuzzycd.rb to your PATH. Assuming you put fuzzycd in your ~/scripts/ directory:
export PATH=~/scripts/fuzzycd/:$PATH
-
- # Wrap the builtin bash cd command with the fuzzy cd command
source ~/scripts/fuzzycd/fuzzycd_bash_wrapper.sh
-Enjoy!
+This will effectively wrap the builtin bash cd command with the fuzzy cd command. Enjoy!
Improvements
-============
+------------
If you have any improvements, feel free to send me an email or a pull request.

0 comments on commit 08de014

Please sign in to comment.