Skip to content

Commit

Permalink
add more help for README.md
Browse files Browse the repository at this point in the history
Signed-off-by: lilei <[email protected]>
  • Loading branch information
lilei committed Jan 17, 2020
1 parent 9052368 commit 9227211
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 7 deletions.
60 changes: 57 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,58 @@
LLVIMRC
=======
# The LeeLei vimrc configuration

llvimrc is a distribution of vim plugins and resources for Vim.
This is a distribution of vim plugins for CentOS8.x or later, supporting language c, c++, python, golang and shell.

## How to install

```shell
# ./install.sh
```

## Key Mappings

The [leader](http://learnvimscriptthehardway.stevelosh.com/chapters/06.html#leader) is `/`, so whenever you see `<leader>` it means `/`.

### Key Maps
```shell
nmap <F3> :cp<cr>
nmap <F4> :cn<cr>

nmap <F5> :TagbarToggle<cr>
nmap <F6> :call AutoloadcsQuickfixToggle()<cr>
nmap <F7> :NERDTreeToggle<cr>
nmap <F8> :call LeeCtagsCscope()<cr>

<C-p> : List files
<C-]> : Go to function define, for c, c++ or golang
<C-t> : Go back position of stack, for c, c++ or golang
<C-l> : Code completion only for golang
```

### Leaders
```shell
nmap <leader>- <Plug>AirlineSelectPrevTab
nmap <leader>= <Plug>AirlineSelectNextTab
nmap <Leader>+ :bd<cr>

nmap <leader>cc :NERDComYankComment<cr>
nmap <leader>cs :NERDComSexyComment<cr>
nmap <leader>cu :NERDComUncommentLine<cr>

nmap <leader>m :MarkSet<cr>
nmap <leader>M :MarkClear<cr>

nmap <leader>n :Go to function define, only for python
```

### Cscope
```shell
<C-\>t : Match string
<C-\>s : Match symbol exclude comment
```

### Command
```shell
Dox : Add comment for function
DoxAuthor : Add comment for source file
DoxLic :Add license for source file
```
9 changes: 5 additions & 4 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ if [ -f /etc/vimrc ] && [ ! -f /etc/vimrc.bak ]; then
touch /etc/vimrc
fi

rm -rf /root/.vim >/dev/null 2>&1
rm -f /root/.vimrc >/dev/null 2>&1
cp -rf vim /root/.vim
cp -f vimrc /root/.vimrc
rm -rf /$HOME/.vim >/dev/null 2>&1
rm -f /$HOME/.vimrc >/dev/null 2>&1
cp -rf vim /$HOME/.vim
cp -f vimrc /$HOME/.vimrc

echo -e "\033[32m- Install successfully...\033[0m"

exit 0

0 comments on commit 9227211

Please sign in to comment.