xavier/config-astronvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Updated README

Browse Source
This commit is contained in:
Xavier Logerais 2024-05-22 17:15:43 +02:00
parent b3c8e11f32
commit bed1f95b7c
1 changed files with 3 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,34 +1,18 @@
# AstroNvim Template
# AstroNvim configuration
**NOTE:** This is for AstroNvim v4+
A template for getting started with [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
mv ~/.local/state/nvim ~/.local/state/nvim.bak
mv ~/.cache/nvim ~/.cache/nvim.bak
```
#### 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
git clone https://gitea.logerais.com/xavier/config-astronvim.git ~/.config/astronvim
```
#### Start Neovim
```shell
export NVIM_APPNAME=astronvim
nvim
```