39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
# AstroNvim User Configuration 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
|
|
```
|
|
|
|
#### Create a new user repository from this template
|
|
|
|
Press the "Use this template" button above to create a new repository to store your user configuration.
|
|
|
|
You can also just clone this repository directly if you do not want to track your user configuration in GitHub.
|
|
|
|
#### Clone the repository
|
|
|
|
```shell
|
|
git clone https://github.com/<your_user>/<your_repository> ~/.config/nvim/lua/user
|
|
```
|
|
|
|
#### Start Neovim
|
|
|
|
```shell
|
|
nvim
|
|
```
|