diff --git a/README-ENG.md b/README-ENG.md index 5ae5155..e175dfc 100644 --- a/README-ENG.md +++ b/README-ENG.md @@ -1,3 +1,9 @@ +<div align="center"> + + + +</div> + ## Table of Contents - [Why VimsCode](#why-vimscode) @@ -46,63 +52,27 @@ VimsCode is an IDE with vim for beginner or expert : ## Quick Start -### Introduction : - -Installation requires : ``` -sudo apt update -sudo apt install git elinks -git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim +git clone https://git.cohabit.fr/bastien/VimsCode.git +cd VimsCode && ./vimscode.sh -install ``` -### Set up VimsCode : - - -After clone don't forgot to rename "vimrc-conf" -> ".vimrc" : - -``` -cd Vimscode -chmod +x install.sh -./install.sh -``` - -### Alias : - -When you load vim, you have 1 error with vim-colorschemes, its totally normal, because your vimrc use theme but you dont have load this theme. - -Edit your bashrc or zshrc and copie/paste this ligne at the end : -``` -vim ~/.zshrc or vim ~/.bashrc -alias vimscode="~/.vim/vimscode.sh" -``` - -### Install Plugins : - -Launch `vim` and run `:PluginInstall` - ## Documentation -### Short-cute VimsCode : +### Shortcuts VimsCode : -This short-cute are totally switchable in .vimrc. +All VimsCode shortcuts are fully configurable in the .vimrc: ``` -"F2" Shows a vim note -"F3" Shows the tree structure -"F4" Shows the history of changes made -"F5" Shows a terminal at the bottom -"F6" Allows scrolling in the terminal -"F7" Brings up a help site for vim and terminal -"F8" created a new vim tab -"F9" navigate between vim tabs -"c-s" vertical split of the window -"F10" "F10" close vimscode +"Ctrl+l" Shows all VimsCode shortcuts ``` -* Shortcut in visual mode, when you highlight a word, do a duckduckgo search, on press "g". -* You can change the hight of window with mouse. +* The shortcut in visual mode allows you to search the internet for the selected word by pressing "g". +* You can use the mouse in VimsCode to change elements or others... +* To go back in the shortcut popup, you need to use the "backspace" key. -Finally you can run vimscode with this alias : + +Finally, you can launch VimsCode with these aliases, or if you prefer, you can launch it with Vim, but you will not have the VimsCode interface triggered: ``` vimscode -e "file" # for ESP ide vimscode -a "file" # for Arduino ide @@ -110,7 +80,8 @@ vimscode -p "file" # for platform.io ide vimscode # help vimscode ``` -If you want change theme of vimscode, you can just change this line : +If you want to change the VimsCode theme, you can change it with these lines: + ``` colorscheme space-vim-dark colorscheme cool @@ -118,7 +89,7 @@ colorscheme elda colorscheme space-vim-dark colorscheme black_angus ``` -And other theme : [Theme](https://github.com/flazz/vim-colorschemes/tree/master/colors) +And to see other themes: : [Theme](https://github.com/flazz/vim-colorschemes/tree/master/colors) ### More Doc : @@ -127,15 +98,8 @@ And other theme : [Theme](https://github.com/flazz/vim-colorschemes/tree/master/ ## Update -For update it's very simple you juste have to pull and do some mv: +To update VimsCode, simply type this command: ``` -cd ~/.vim -chmod +x update-vimscode -./update-vimscode -``` - -## Troubleshooting - -For troubleshooting and common problems see [TROUBLESHOOTING](https://git.cohabit.fr/bastien/VimsCode/wiki/Troubleshooting). - +vimscode -maj +``` \ No newline at end of file