AstroNvim_template/.github/README.md

33 lines
776 B
Markdown

# AstroNvim Structured User Example
A user configuration template for [AstroNvim](https://github.com/AstroNvim/AstroNvim)
**Note:** This repository does require AstroNvim v3.0. Because of this, `nightly` is currently the default update channel until v3.0 is released to stable when it will be changed to using `stable` by default.
## 🛠️ 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
```