updated readme
This commit is contained in:
parent
e6d89bbbf4
commit
e33c2e623b
16
README.md
16
README.md
|
|
@ -2,37 +2,31 @@ Neovim Config
|
||||||
=============
|
=============
|
||||||
|
|
||||||
## What is this?
|
## What is this?
|
||||||
These are my personal configuration for neovim.
|
Personal configuration for neovim.
|
||||||
|
|
||||||
## How to use this config?
|
## How to use this config?
|
||||||
This Configuration works best in GNU/Linux platform. Other systems are also supported, but they see less testing, so expect more bugs.
|
This Configuration works best in GNU/Linux platform. Other systems are also supported, but they see less testing, so expect more bugs.
|
||||||
Supported Systems:
|
Supported Systems:
|
||||||
- MS Windows, preferably running on MSYS2 Environment (Running on MS Windows directly is untested)
|
- MS Windows, preferably running on MSYS2 Environment (Running on MS Windows directly is untested)
|
||||||
- Android, on Termux
|
- Android, on Termux
|
||||||
- Theoretically it runs on MacOS and BSDs, but it’s untested, as I don’t have access to any MacOS/BSD system (yet)
|
- Theoretically it runs on MacOS and BSDs, but it’s untested
|
||||||
|
|
||||||
### Neovim Version
|
### Neovim Version
|
||||||
This configuration can only be used with Neovim version 0.5 and up
|
This configuration can only be used with Neovim version 0.10 and up
|
||||||
|
|
||||||
### External Dependencies
|
### External Dependencies
|
||||||
Some plugins require python extensions for neovim
|
Some plugins require python extensions for neovim
|
||||||
|
|
||||||
#### Language Servers
|
#### Language Servers
|
||||||
|
`npm`, `pip`, and `git` commands are required for language server installations
|
||||||
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
1. Download/Clone this git repo to ```$HOME/.config/nvim```
|
Download/Clone this git repo to ```$HOME/.config/nvim```
|
||||||
```sh
|
```sh
|
||||||
mkdir -p $HOME/.config
|
mkdir -p $HOME/.config
|
||||||
git clone "https://git.telosama.xyz/iang/neovim-config.git" $HOME/.config/nvim
|
git clone "https://git.telosama.xyz/iang/neovim-config.git" $HOME/.config/nvim
|
||||||
```
|
```
|
||||||
3. Start Neovim , then do this command:
|
|
||||||
```
|
|
||||||
:PackerSync
|
|
||||||
:PackerCompile
|
|
||||||
:COQdeps
|
|
||||||
```
|
|
||||||
And Done!
|
|
||||||
|
|
||||||
## Philosophy
|
## Philosophy
|
||||||
- Just to keep it as simple as possible
|
- Just to keep it as simple as possible
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue