docs: add README with basic instructions
parent
aac7f99b05
commit
e26457c13e
|
@ -0,0 +1,30 @@
|
|||
# AstroNvim Structured User Example
|
||||
|
||||
A user configuration template for [AstroNvim](https://github.com/AstroNvim/AstroNvim)
|
||||
|
||||
## 🛠️ Installation
|
||||
|
||||
#### Make a backup of your current nvim and shared folder
|
||||
|
||||
```shell
|
||||
mv ~/.config/nvim ~/.config/nvim.bak
|
||||
mv ~/.local/share/nvim ~/.local/share/nvim.bak
|
||||
```
|
||||
|
||||
#### Clone AstroNvim
|
||||
|
||||
```shell
|
||||
git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
|
||||
```
|
||||
|
||||
#### Clone the repository
|
||||
|
||||
```shell
|
||||
git clone https://github.com/AstroNvim/split_user_example ~/.config/nvim/lua/user
|
||||
```
|
||||
|
||||
#### Start Neovim
|
||||
|
||||
```shell
|
||||
nvim
|
||||
```
|
Loading…
Reference in New Issue