Splitting up docs

doc/credits.md

@@ -0,0 +1,26 @@
+I can't take credit for all of this. The vim files are a combination of
+work by tpope, scrooloose, and many hours of scouring blogs, vimscripts,
+and other places for the cream of the crop of vim awesomeness.
+
+ * http://ethanschoonover.com/solarized - a scientifically calibrated color scheme
+ * https://github.com/astrails/dotvim
+ * https://github.com/carlhuda/janus
+ * https://github.com/tpope
+ * https://github.com/scrooloose
+ * https://github.com/kana
+ * https://github.com/sorin-ionescu
+ * https://github.com/nelstrom
+
+And everything that's in the modules included in vim/bundle of course.
+Please explore these people's work.
+
+
+### Contributors
+
+Yadr is made possible by many awesome people, too many to list :) But here are a few of the bigger contributors and core committers.
+
+ * Initial Version: @[skwp](https://github.com/skwp)
+ * Cleanup, auto installer: @[kylewest](https://github.com/kylewest)
+ * Switch from oh-my-zsh to Presto: @[JeanMertz](https://github.com/JeanMertz)
+ * Vundle migration: @[duhanebel](https://github.com/duhanebel)
+

doc/osx_tools.md

@@ -0,0 +1,5 @@
+## Recommended OSX Tools
+
+ * NValt - Notational Velocity alternative fork - http://brettterpstra.com/project/nvalt/ - syncs with SimpleNote
+ * Vimium for Chrome - vim style browsing. The `f` to type the two char alias of any link is worth it.
+ * QuickCursor - gives you Apple-Shift-E to edit any OSX text field in vim.

doc/pry.md

@@ -0,0 +1,22 @@
+### Install the gem
+
+```bash
+gem install jazz_hands
+```
+
+[Jazz hands](https://github.com/nixme/jazz_hands) is a nice bundling of all pry-related gems.
+
+### Use pry
+
+  * as irb: `pry`
+  * as rails console: `script/console --irb=pry`
+  * as a debugger: `require 'pry'; binding.pry` in your code (or just type `pry!<space>` to make vim do it)
+
+### Pry Customizations:
+
+ * `clear` command to clear screen
+ * `sql` command to execute something (within a rails console)
+ * `c` (continue) `n` (next) `s` (step) commands for debugging using pry-nav
+ * all objects displayed in readable format (colorized, sorted hash keys) - via awesome_print
+ * a few color modifications to make it more useable
+ * type `help` to see all the commands

doc/vim/coding.md

@@ -0,0 +1,14 @@
+* tComment - gcc to comment a line, gcp to comment blocks, nuff said
+* rails.vim - syntax highlighting, gf (goto file) enhancements, and lots more. should be required for any rails dev
+* rake.vim - like rails.vim but for non-rails projects. makes `:Rtags` and other commands just work
+* ruby.vim - lots of general enhancements for ruby dev
+* necomplcache - intelligent and fast complete as you type, and added Command-Space to select a completion (same as Ctrl-N)
+* snipMate - offers textmate-like snippet expansion + scrooloose-snippets . try hitting TAB after typing a snippet
+* jasmine.vim - support for jasmine javascript unit testing, including snippets for it, before, etc..
+* vim-javascript-syntax, vim-jquery - better highlighting
+* TagHighlight - highlights class names and method names
+* vim-coffeescript - support for coffeescript, highlighting
+* vim-stylus - support for stylus css language
+* vim-bundler - work with bundled gems
+* fugitive - "a git wrapper so awesome, it should be illegal...". Try `:Gstatus` and hit `-` to toggle files in and out of the index. Git `d` to see a diff. Use `git mergetool` or `gmt` to launch vim as a mergetool. The left buffer is your branch, the right is the incoming change, and in the middle is the working copy. Move to the left or right and use `dp` to put the change into the middle. Learn more: http://vimcasts.org/blog/2011/05/the-fugitive-series/
+* gitv - use `:gitv` for a better git log browser

doc/vim/enhancements.md

@@ -0,0 +1,11 @@
+* IndexedSearch - when you do searches will show you "Match 2 of 4" in the status line
+* delimitMate - automatically closes quotes
+* SearchComplete - tab completion in the / search window
+* syntastic - automatic syntax checking when you save the file
+* repeat - adds `.` (repeat command) support for complex commands like surround.vim. i.e. if you perform a surround and hit `.`, it will Just Work (vim by default will only repeat the last piece of the complex command)
+* endwise - automatically closes blocks (if/end)
+* autotag - automatically creates tags for fast sourcecode browsing. use `,f` over a symbol name to go to its definition
+* matchit - helps with matching brackets, improves other plugins
+* AnsiEsc - inteprets ansi color codes inside log files. great for looking at Rails logs
+* solarized - a color scheme scientifically calibrated for awesomeness (including skwp mods for ShowMarks)
+* Airline - Improved status bar. Requires patched fonts (installed from fonts/ directory)

doc/vim/keymaps.md

@@ -0,0 +1,7 @@
+The files in `vim/settings` are customizations stored on a per-plugin
+basis. The main keymap is available in skwp-keymap.vim, but some of the vim
+files contain key mappings as well.
+
+If you are having unexpected behavior, wondering why a particular key works the way it does,
+use: `:map [keycombo]` (e.g. `:map <C-\>`) to see what the key is mapped to. For bonus points, you can see where the mapping was set by using `:verbose map [keycombo]`.
+If you omit the key combo, you'll get a list of all the maps. You can do the same thing with nmap, imap, vmap, etc.

doc/vim/manage_plugins.md

@@ -0,0 +1,12 @@
+YADR comes with a dead simple plugin manager that just uses vundles and submodules, without any fancy config files.
+
+Add a plugin
+
+    yav -u https://github.com/airblade/vim-rooter
+
+Delete a plugin 
+
+    ydv -u airblade/vim-rooter
+
+The aliases (yav=yadr vim-add-plugin), (ydp=yadr vim-delete-plugin) and (yuv=yadr vim-update-all-plugins) live in the aliases file.
+You can then commit the change. It's good to have your own fork of this project to do that.

doc/vim/navigation.md

@@ -0,0 +1,8 @@
+* NERDTree - everyone's favorite tree browser
+* NERDTree-tabs - makes NERDTree play nice with MacVim tabs so that it's on every tab
+* ShowMarks - creates a visual gutter to the left of the number column showing you your marks
+* EasyMotion - hit ,<esc> (forward) or ,<Shift-Esc> (back) and watch the magic happen. Just type the letters and jump directly to your target - in the provided vimrc the keys are optimized for home row mostly. Using @skwp modified EasyMotion which uses vimperator-style two character targets.
+* TagBar - hit ,T to see a list of methods in a class (uses ctags)
+* CtrlP - ,t to find a file
+* Visual-star-search - make the * (star) search in visual mode behave like expected: searching for the whole selection instead of just the word under the cursor.
+* GitGrep - much better than the grep provided with fugitive; use `:GitGrep` or hit `K` to grep current word

doc/vim/override.md

@@ -0,0 +1,5 @@
+You may use `~/.vimrc.before` for settings like the __leader__ setting.
+You may `~/.vimrc.after` (for those transitioning from janus) or in `~/.yadr/vim/after/.vimrc.after` for any additional overrides/settings.
+If you didn't have janus before, it is recommended to just put it in `~/.yadr/vim/after` so you can better manage your overrides.
+
+

doc/vim/textobjects.md

@@ -0,0 +1,11 @@
+* textobj-rubyblock - ruby blocks become vim textobjects denoted with `r`. try var/vir to select a ruby block, dar/dir for delete car/cir for change, =ar/=ir for formatting, etc
+* vim-indentobject - manipulate chunks of code by indentation level (great for yaml) use vai/vii to select around an indent block, same as above applies
+* argtextobj - manipulation of function arguments as an "a" object, so vaa/via, caa/cia, daa/dia, etc..
+* textobj-datetime - gives you `da` (date), `df` (date full) and so on text objects. useable with all standard verbs
+* vim-textobj-entire - gives you `e` for entire document. so vae (visual around entire document), and etc
+* vim-textobj-rubysymbol - gives you `:` textobj. so va: to select a ruby symbol. da: to delete a symbol..etc
+* vim-textobj-function - gives you `f` textobj. so vaf to select a function
+* vim-textobj-function-javascript - same as above, but for javascript functions
+* vim-textobj-underscore - gives you `_` textobj. So vi_ selects what's inside a pair of underscores
+* next-textobject - from Steve Losh, ability to use `n` such as vinb (visual inside (n)ext set of parens)
+* textobj-word-column - gives you `c` (word) and `C` (WORD) for handling columns/blocks.

doc/vim/utils.md

@@ -0,0 +1,16 @@
+* SplitJoin - easily split up things like ruby hashes into multiple lines or join them back together. Try :SplitjoinJoin and :SplitjoinSplit or use the bindings sj(split) and sk(unsplit) - mnemonically j and k are directions down and up
+* tabularize - align code effortlessly by using :Tabularize /[character] to align by a character, or try the keymaps
+* yankring - effortless sanity for pasting. every time you yank something it goes into a buffer. after hitting p to paste, use ctrl-p or ctrl-n to cycle through the paste options. great for when you accidentally overwrite your yank with a delete.
+* surround - super easy quote and tag manipulation - ysiw" - sourround inner word with quotes. ci"' - change inner double quotes to single quotes, etc
+* greplace - use :Gsearch to find across many files, replace inside the changes, then :Greplace to do a replace across all matches - made lightning fast with Silver Searcher
+* ConqueTerm - embedded fully colorful shell inside your vim
+* vim-ruby-conque - helpers to run ruby,rspec,rake within ConqueTerm
+* vim-markdown-preview - :Mm to view your README.md as html
+* html-escape - ,he and ,hu to escape and unescape html
+* Gundo - visualize your undos - pretty amazing plugin. Hit ,u with my keymappings to trigger it, very user friendly
+* vim-indent-guides - visual indent guides, off by default
+* color_highlight - use :ColorCodes to see hex colors highlighted
+* change-inside-surroundings - change content inside delimiters like quotes/brackets
+* Specky - used for color highlighting rspec correctly even if specs live outside of spec/ (rails.vim doesn't handle this)
+* Ag - use :Ag to search across multiple files. Faster than Grep and Ack.
+* vim-session: use `:SaveSession` and `:OpenSession` to come back to your saved window layout

doc/zsh/themes.md

@@ -0,0 +1,24 @@
+### Adding your own ZSH theme
+
+If you want to add your own zsh theme, you can place it in `~/.zsh.prompts` and it will automatically be picked up by the prompt loader.
+
+Make sure you follow the naming convention of `prompt_[name]_setup`
+
+```
+touch ~/.zsh.prompts/prompt_mytheme_setup
+```
+
+See also the [Prezto](https://github.com/sorin-ionescu/prezto) project for more info on themes.
+
+### Customizing ZSH & Picking a theme
+
+If you want to customize your zsh experience, yadr provides two hooks via `~/.zsh.after/` and `~/.zsh.before/` directories.
+In these directories, you can place files to customize things that load before and after other zsh customizations that come from `~/.yadr/zsh/*`
+
+For example, to override the theme, you can do something like this:
+
+```
+echo "prompt yourprompt" > ~/.zsh.after/prompt.zsh
+```
+
+Next time you load your shell, this file will be read and your prompt will be the youprompt prompt. Use `prompt -l` to see the available prompts.