updated readme

This commit is contained in:
Ian Griffin 2025-03-25 23:42:01 +08:00
parent e6d89bbbf4
commit e33c2e623b
1 changed files with 5 additions and 11 deletions

View File

@ -2,37 +2,31 @@ Neovim Config
=============
## What is this?
These are my personal configuration for neovim.
Personal configuration for neovim.
## 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.
Supported Systems:
- MS Windows, preferably running on MSYS2 Environment (Running on MS Windows directly is untested)
- Android, on Termux
- Theoretically it runs on MacOS and BSDs, but its untested, as I dont have access to any MacOS/BSD system (yet)
- Theoretically it runs on MacOS and BSDs, but its untested
### 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
Some plugins require python extensions for neovim
#### Language Servers
`npm`, `pip`, and `git` commands are required for language server installations
### Installation
1. Download/Clone this git repo to ```$HOME/.config/nvim```
Download/Clone this git repo to ```$HOME/.config/nvim```
```sh
mkdir -p $HOME/.config
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
- Just to keep it as simple as possible