aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--LICENSE19
-rw-r--r--README.md39
2 files changed, 58 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..532353c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2014 Teddy Wing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE. \ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d4dcd2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+.vim
+====
+
+My personal vim config. Includes various mappings and plugins. Plugins are loaded with [pathogen.vim](https://github.com/tpope/vim-pathogen).
+
+Feel free to take a look and copy what you like.
+
+
+## Installation
+1. Backup your `.vimrc` and `.vim` directory
+2. Clone into your `~/.vim` directory
+3. Run `git submodule init && git submodule update`
+4. Link `.vimrc` to `~/.vim/vimrc`
+
+ ln -s .vim/vimrc .vimrc
+
+
+## Dependencies
+Currently requires:
+
+* `ack`: for more intelligent project searching
+
+
+## Plugins
+* [pathogen.vim](https://github.com/tpope/vim-pathogen): plugin management
+* [Command-T](https://github.com/wincent/Command-T): easy file loading
+* [NerdTree](https://github.com/scrooloose/nerdtree): pleasant file browser
+* [commentary.vim](https://github.com/tpope/vim-commentary): easy code commenting
+* [PreserveNoEOL](https://github.com/vim-scripts/PreserveNoEOL/): preserve EOLs
+* [EasyGrep](https://github.com/vim-scripts/EasyGrep): easy find and replace in project
+
+
+Disabled plugins:
+
+* [TabBar](https://github.com/vim-scripts/TabBar): show buffers in tabs
+
+
+## License
+Licensed under the MIT license. See the included LICENSE file.