Added a writeup of features and some information about accessing them to

the README, made <backspace> delete the selection and cursor character
in visual and normal modes respectively, and set \| to add the currently
selected word to the local dictionary for spellcheck (remembering that
\\ displays a list of correct spellings)
This commit is contained in:
Kevin 2014-03-28 11:13:10 -04:00
parent 2ee0a576e3
commit 426acb2b14
4 changed files with 21 additions and 10 deletions

3
.gitmodules vendored
View file

@ -34,9 +34,6 @@
[submodule "vim/bundle/emmet-vim"]
path = vim/bundle/emmet-vim
url = https://github.com/mattn/emmet-vim.git
[submodule "vim/bundle/hexHighlight.vim"]
path = vim/bundle/hexHighlight.vim
url = https://github.com/vim-scripts/hexHighlight.vim.git
[submodule "vim/bundle/nerdtree"]
path = vim/bundle/nerdtree
url = https://github.com/scrooloose/nerdtree.git

View file

@ -5,18 +5,18 @@
1. Git and Bash: Required to manage plugin updates using the "pathogen_update_plugins" script.
2. CTags: Available @ http://ctags.sourceforge.net, this can be in $PATH or in the vim folder and is required for the tagbar plugin.
3. Vim v7.4+: Everything has been written and tested using Vim 7.4.135, and I assume there could be issues with 7.3 and below.
4. Powerline Fonts (optional): Required for the powerline lightline theme, which can be toggled in /etc/vimrc along with the gVim font
4. Powerline Fonts (optional): Required for the powerline lightline theme, which can be toggled in /etc/vimrc along with the gvim font
## Installation/Setup
## Installation
1. Clone this repository then initialize and update the git submodules (in our case, the vim plugins)
* ]$ git clone https://github.com/prurigro/darkcloud-vimconfig.git
* ]$ cd darkcloud-vimconfig
* ]$ git submodule init
* ]$ git submodule update
2. Edit the 'vimrc' file and select whether to expect powerline fonts, choose a font for gVim, and add or change any of the loaded config files to match your personal setup.
2. Edit the 'vimrc' file and select whether to expect powerline fonts, choose a font for gvim, and add or change any of the loaded config files to match your personal setup.
3. There are two main ways this package can be deployed: system-wide or single-user.
* For a distro-agnostic system-wide installation in the /etc directory, copy or link: 'vimrc' to '/etc/vimrc' -and- the 'vim' folder to '/etc/vim'.
* For a distro-agnostic system-wide installation in the /etc directory, copy or link: 'vimrc' to '/etc/vimrc' and the 'vim' folder to '/etc/vim'.
* For a single-user installation in a user's home directory, copy or link: 'vimrc' to '~/.vimrc' -and- the 'vim' folder to '~/.vim'.
4. Make sure the 'vimrc' file and 'vim' folder are at least readable to any users that will be using the config.
5. Clone additional vim plugin repos in the 'bundle' folder to have them loaded at startup.
@ -24,9 +24,16 @@
7. Run the pathogen_update_plugins script to update your plugins by pulling the latest changes from each plugin repo.
8. The 'vim/config/keyboard.vim' file has a list of the commands it configures, as well as some basic examples of some provided directly by plugins (though check the plugin folder's README for a full explanation).
## Features
* An original theme designed to be readable and aesthetically pleasing.
* A complete default configuration to start with and work from that aims to improve compatibility and provide sane, modern standards.
* Keyboard/mouse bindings that attempt to maintain vim's default behaviour while adding behaviour common to other text editors, improving accessibility to useful features, and making the mouse more capable (check the comments at the top of vim/config/keyboard.vim for a list of bindings and what they do).
* A core set of plugins that add some handy features and better support for some formats (you may want to remove plugins in vim/bundle/ supporting formats you won't be using).
## Credits
* Written by prurigro: [Github Projects](https://github.com/prurigro) | [Archlinux AUR Packages](https://aur.archlinux.org/packages/?SeB=m&K=prurigro)
* Written by prurigro: [GitHub Projects](https://github.com/prurigro) | [Arch Linux AUR Packages](https://aur.archlinux.org/packages/?SeB=m&K=prurigro)
* Many other authors have their work contained in this repo, most of which are self contained in the vim/bundle directory. I also used the Vim jellybean theme as a basis for the Darkcloud theme, which is maintained by NanoTech <http://nanotech.nanotechcorp.net/>
## License

@ -1 +0,0 @@
Subproject commit 1d7578067fcb1de1bcde88a3dfbc9a0be8088141

View file

@ -18,11 +18,14 @@
" <Ctrl-t> | (A) -> open a new tab
" <Ctrl-n> | (A) -> go to the next open tab
" <Ctrl-p> | (A) -> go to the previous open tab
" <Backspace> | (V) -> deletes currently selected text
" <Backspace> | (N) -> deletes the character behind the cursor
" <Tab> | (V) -> indent all the lines currently selected
" <Tab> | (N) -> indent the current line
" <Shift-Tab> | (V) -> unindent all the lines currently selected
" <Shift-Tab> | (N) -> unindent the current line
" \\ | (N) -> show spelling suggestions popup for selection
" \\ | (N) -> show spelling suggestions popup for word
" \| | (N) -> add word to a local list of correct spellings
" ` | (N) -> toggle the nerdtree sidebar
" ~ | (N) -> toggle the tagbar sidebar
" p | (V) -> paste and replace the selection
@ -82,6 +85,10 @@
noremap <C-ScrollWheelUp> 3zl
noremap <C-ScrollWheelDown> 3zh
"have backspace delete the highlighted selection in visual mode
vnoremap <Backspace> x
nnoremap <Backspace> i<Backspace><Esc>l
"tab and untabbing selected blocks
vnoremap <Tab> >gv
vnoremap <S-Tab> <gv
@ -90,6 +97,7 @@
"press backslash twice on a mispelled word for suggestions
nnoremap \\ ea<C-X><C-S>
nnoremap \| zg
"move to the next and previous tabs
nnoremap <silent><expr> <C-t> ':tabnew<CR>'