docs: add README with basic instructions

This commit is contained in:
Micah Halter 2023-01-14 14:24:08 -05:00
parent aac7f99b05
commit e26457c13e
No known key found for this signature in database
GPG Key ID: 4224A6EA9A8CAAA8
1 changed files with 30 additions and 0 deletions

30
.github/README.md vendored Normal file
View File

@ -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
```