Skip to content

Commit 5ae964d

Browse files
Update README.md
1 parent 7a70c51 commit 5ae964d

File tree

1 file changed

+137
-1
lines changed

1 file changed

+137
-1
lines changed

README.md

Lines changed: 137 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,137 @@
1-
# Started-Draco-Vim
1+
# Started-Draco-Vim
2+
![94shots_so](https://github.com/user-attachments/assets/238523dc-323f-4f7d-8cc5-d8cd28d92a6c)
3+
![Version](https://img.shields.io/badge/version-1.0.0-blue)
4+
![Vim Version](https://img.shields.io/badge/vim-%3E%3D8.2-green)
5+
![Contributors](https://img.shields.io/badge/contributors-vicenteroa-orange)
6+
![Issues](https://img.shields.io/github/issues/vicenteroa/Started-Draco-Vim)
7+
![License](https://img.shields.io/github/license/vicenteroa/Started-Draco-Vim)
8+
# Vim Installation and Configuration Guide
9+
10+
## Plug Installation
11+
12+
### On Windows
13+
14+
1. **Install Vim**:
15+
- Make sure you have Vim installed. You can download it from [vim.org](https://www.vim.org/download.php) or install it via [Chocolatey](https://chocolatey.org/) using the command `choco install vim`.
16+
17+
2. **Install Plug**:
18+
- Open a terminal (cmd or PowerShell).
19+
- Run the following command to download Plug and place it in the appropriate directory:
20+
```sh
21+
curl -fLo %USERPROFILE%\vimfiles\autoload\plug.vim --create-dirs \
22+
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
23+
```
24+
25+
3. **Configure Plug in Vim**:
26+
- Create or edit the `_vimrc` file in `%USERPROFILE%`.
27+
- Add the following content to initialize Plug:
28+
```vim
29+
call plug#begin('~/.vim/plugged')
30+
" List of plugins here
31+
call plug#end()
32+
```
33+
34+
### On Linux
35+
36+
1. **Install Vim**:
37+
- Make sure you have Vim installed. You can install it using your package manager, for example:
38+
```sh
39+
sudo apt-get install vim
40+
```
41+
42+
2. **Install Plug**:
43+
- Open a terminal.
44+
- Run the following command to download Plug:
45+
```sh
46+
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
47+
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
48+
```
49+
50+
3. **Configure Plug in Vim**:
51+
- Create or edit the `.vimrc` file in your home directory.
52+
- Add the following content to initialize Plug:
53+
```vim
54+
call plug#begin('~/.vim/plugged')
55+
" List of plugins here
56+
call plug#end()
57+
```
58+
59+
## Custom Configuration
60+
61+
This `.vimrc` file configures various aspects of your Vim environment. Here's a description of each section:
62+
63+
### Plugins
64+
65+
Plugins are managed by Plug and are initialized with:
66+
```vim
67+
call plug#begin('~/.vim/plugged')
68+
" List of plugins here
69+
call plug#end()
70+
```
71+
72+
73+
## General Settings
74+
75+
```vim
76+
set relativenumber
77+
set showcmd
78+
set showmatch
79+
set tabpagemax=10
80+
set showtabline=2
81+
set laststatus=2
82+
set timeoutlen=500
83+
```
84+
- relativenumber: Shows relative line numbers.
85+
- showcmd: Displays the current command in the status line.
86+
- showmatch: Highlights matching parentheses or brackets.
87+
- tabpagemax: Maximum number of tab pages.
88+
- showtabline: Always show the tab line.
89+
- laststatus: Always show the status line.
90+
- timeoutlen: Timeout for key sequences.
91+
## Plugin Settings
92+
- NERDTree: File explorer.
93+
- Airline: Status line with custom themes.
94+
- which-key: Displays available key mappings.
95+
- coc.nvim: Autocompletion and LSP support.
96+
## Key Mappings
97+
- <Leader><Space>: Opens the which-key menu.
98+
- <Space>e: Toggles NERDTree.
99+
- <S-H>/<S-L>: Navigates between tabs.
100+
- <C-s>: Saves the current file.
101+
102+
## coc.nvim Configuration
103+
```vim
104+
let g:coc_global_extensions = [
105+
\ 'coc-json',
106+
\ 'coc-tsserver',
107+
\ 'coc-html',
108+
\ 'coc-css',
109+
\ 'coc-eslint',
110+
\ 'coc-prettier',
111+
\ ]
112+
```
113+
Installs extensions for language support and development tools.
114+
115+
# Best Workflow
116+
Start Vim:
117+
118+
- Open Vim and use :PlugInstall to install all the listed plugins.
119+
- Open Files Using Startify:
120+
121+
- Use Startify to quickly open recent files, directories, and sessions if available.
122+
Create New Buffers:
123+
Use Shift + n to create a new buffer.
124+
Open Files:
125+
126+
- Use Space Space to open any file you need at the moment.
127+
Explore and Use Plugins:
128+
Use :NERDTreeToggle to explore files.
129+
Use :Files to quickly search for files.
130+
Use :Gstatus to manage Git status.
131+
Customize Your Environment:
132+
133+
Adjust key mappings and settings according to your workflow.
134+
Keep Updated:
135+
136+
Update your plugins with :PlugUpdate.
137+
Follow these steps to set up and customize your Vim environment. Enjoy an efficient and productive workflow.

0 commit comments

Comments
 (0)