Fix README.md grammar and typos (#1291)
This commit is contained in:
		
							parent
							
								
									de44f49101
								
							
						
					
					
						commit
						e84e187f3c
					
				
							
								
								
									
										14
									
								
								README.md
								
								
								
								
							
							
						
						
									
										14
									
								
								README.md
								
								
								
								
							| 
						 | 
					@ -24,7 +24,7 @@ If you are experiencing issues, please make sure you have the latest versions.
 | 
				
			||||||
External Requirements:
 | 
					External Requirements:
 | 
				
			||||||
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
 | 
					- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
 | 
				
			||||||
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
 | 
					- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
 | 
				
			||||||
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
 | 
					- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
 | 
				
			||||||
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
 | 
					- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
 | 
				
			||||||
  - if you have it set `vim.g.have_nerd_font` in `init.lua` to true
 | 
					  - if you have it set `vim.g.have_nerd_font` in `init.lua` to true
 | 
				
			||||||
- Language Setup:
 | 
					- Language Setup:
 | 
				
			||||||
| 
						 | 
					@ -56,12 +56,12 @@ so that you have your own copy that you can modify, then install by cloning the
 | 
				
			||||||
fork to your machine using one of the commands below, depending on your OS.
 | 
					fork to your machine using one of the commands below, depending on your OS.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> **NOTE**
 | 
					> **NOTE**
 | 
				
			||||||
> Your fork's url will be something like this:
 | 
					> Your fork's URL will be something like this:
 | 
				
			||||||
> `https://github.com/<your_github_username>/kickstart.nvim.git`
 | 
					> `https://github.com/<your_github_username>/kickstart.nvim.git`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
 | 
					You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
 | 
				
			||||||
too - it's ignored in the kickstart repo to make maintenance easier, but it's
 | 
					too - it's ignored in the kickstart repo to make maintenance easier, but it's
 | 
				
			||||||
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).
 | 
					[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#### Clone kickstart.nvim
 | 
					#### Clone kickstart.nvim
 | 
				
			||||||
> **NOTE**
 | 
					> **NOTE**
 | 
				
			||||||
| 
						 | 
					@ -101,7 +101,7 @@ nvim
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
 | 
					That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
 | 
				
			||||||
current plugin status. Hit `q` to close the window.
 | 
					the current plugin status. Hit `q` to close the window.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Read through the `init.lua` file in your configuration folder for more
 | 
					Read through the `init.lua` file in your configuration folder for more
 | 
				
			||||||
information about extending and exploring Neovim. That also includes
 | 
					information about extending and exploring Neovim. That also includes
 | 
				
			||||||
| 
						 | 
					@ -114,9 +114,9 @@ examples of adding popularly requested plugins.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### FAQ
 | 
					### FAQ
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* What should I do if I already have a pre-existing neovim configuration?
 | 
					* What should I do if I already have a pre-existing Neovim configuration?
 | 
				
			||||||
  * You should back it up and then delete all associated files.
 | 
					  * You should back it up and then delete all associated files.
 | 
				
			||||||
  * This includes your existing init.lua and the neovim files in `~/.local`
 | 
					  * This includes your existing init.lua and the Neovim files in `~/.local`
 | 
				
			||||||
    which can be deleted with `rm -rf ~/.local/share/nvim/`
 | 
					    which can be deleted with `rm -rf ~/.local/share/nvim/`
 | 
				
			||||||
* Can I keep my existing configuration in parallel to kickstart?
 | 
					* Can I keep my existing configuration in parallel to kickstart?
 | 
				
			||||||
  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
 | 
					  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
 | 
				
			||||||
| 
						 | 
					@ -174,7 +174,7 @@ run in cmd as **admin**:
 | 
				
			||||||
winget install --accept-source-agreements chocolatey.chocolatey
 | 
					winget install --accept-source-agreements chocolatey.chocolatey
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
2. install all requirements using choco, exit previous cmd and
 | 
					2. install all requirements using choco, exit the previous cmd and
 | 
				
			||||||
open a new one so that choco path is set, and run in cmd as **admin**:
 | 
					open a new one so that choco path is set, and run in cmd as **admin**:
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
 | 
					choco install -y neovim git ripgrep wget fd unzip gzip mingw make
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue