diff --git a/README.md b/README.md index 90cdf96..54d31e5 100644 --- a/README.md +++ b/README.md @@ -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 `` it means `/`. + +### Key Maps +```shell +nmap :cp +nmap :cn + +nmap :TagbarToggle +nmap :call AutoloadcsQuickfixToggle() +nmap :NERDTreeToggle +nmap :call LeeCtagsCscope() + + : List files + : Go to function define, for c, c++ or golang + : Go back position of stack, for c, c++ or golang + : Code completion only for golang +``` + +### Leaders +```shell +nmap - AirlineSelectPrevTab +nmap = AirlineSelectNextTab +nmap + :bd + +nmap cc :NERDComYankComment +nmap cs :NERDComSexyComment +nmap cu :NERDComUncommentLine + +nmap m :MarkSet +nmap M :MarkClear + +nmap n :Go to function define, only for python +``` + +### Cscope +```shell +t : Match string +s : Match symbol exclude comment +``` + +### Command +```shell +Dox : Add comment for function +DoxAuthor : Add comment for source file +DoxLic :Add license for source file +``` diff --git a/install.sh b/install.sh index abe9ac6..15b1e26 100755 --- a/install.sh +++ b/install.sh @@ -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