docs: Updated README
This commit is contained in:
parent
b3c8e11f32
commit
bed1f95b7c
22
README.md
22
README.md
@ -1,34 +1,18 @@
|
|||||||
# AstroNvim Template
|
# AstroNvim configuration
|
||||||
|
|
||||||
**NOTE:** This is for AstroNvim v4+
|
**NOTE:** This is for AstroNvim v4+
|
||||||
|
|
||||||
A template for getting started with [AstroNvim](https://github.com/AstroNvim/AstroNvim)
|
|
||||||
|
|
||||||
## 🛠️ Installation
|
## 🛠️ 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
|
#### Clone the repository
|
||||||
|
|
||||||
```shell
|
```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
|
#### Start Neovim
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
export NVIM_APPNAME=astronvim
|
||||||
nvim
|
nvim
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user