From 7b08f494e3604f18e7b9b31959a6da6d97abcc65 Mon Sep 17 00:00:00 2001 From: Kevin Bongart Date: Tue, 25 Mar 2014 12:37:25 -0400 Subject: [PATCH] Add README file to rake-fast plugin --- plugins/rake-fast/README.md | 23 +++++++++++++++++++++++ plugins/rake-fast/rake-fast.plugin.zsh | 17 ----------------- 2 files changed, 23 insertions(+), 17 deletions(-) create mode 100644 plugins/rake-fast/README.md diff --git a/plugins/rake-fast/README.md b/plugins/rake-fast/README.md new file mode 100644 index 000000000..f56142f69 --- /dev/null +++ b/plugins/rake-fast/README.md @@ -0,0 +1,23 @@ +# rake-fast + +Fast rake autocompletion plugin. + +This script caches the output for later usage and significantly speeds it up. It generates a .rake_tasks cache file in parallel to the Rakefile. It also checks the file modification dates to see if it needs to regenerate the cache file. + +This is entirely based on [this pull request by Ullrich Schäfer](https://github.com/robb/.dotfiles/pull/10/), which is inspired by [this Ruby on Rails trick from 2006](http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/). + +Think about that. 2006. + +## Installation + +Just add the plugin to your `.zshrc`: + +```bash +plugins=(foo bar rake-fast) +``` + +You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore) + +## Usage + +`rake`, then press tab diff --git a/plugins/rake-fast/rake-fast.plugin.zsh b/plugins/rake-fast/rake-fast.plugin.zsh index 320855233..545b6c049 100644 --- a/plugins/rake-fast/rake-fast.plugin.zsh +++ b/plugins/rake-fast/rake-fast.plugin.zsh @@ -1,20 +1,3 @@ -# rake-fast -# Fast rake autocompletion plugin for oh-my-zsh - -# This script caches the output for later usage and significantly speeds it up. -# It generates a .rake_tasks file in parallel to the Rakefile. - -# You'll want to add `.rake_tasks` to your global .git_ignore file: -# https://help.github.com/articles/ignoring-files#global-gitignore - -# You can force .rake_tasks to refresh with: -# $ rake_refresh - -# This is entirely based on Ullrich Schäfer's work -# (https://github.com/robb/.dotfiles/pull/10/), -# which is inspired by this Ruby on Rails trick from 2006: -# http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/ - _rake_refresh () { if [ -f .rake_tasks ]; then rm .rake_tasks