Skip to content

Commit

Permalink
docs(readme): init
Browse files Browse the repository at this point in the history
  • Loading branch information
nisavid committed Apr 3, 2024
1 parent 8805549 commit 1e12780
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,11 @@
# AstroNvim Template

**NOTE:** This is for AstroNvim v4+

A template for getting started with [AstroNvim](https://github.com/AstroNvim/AstroNvim)
# AstroNvim Configuration

## 🛠️ 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 configuration

```shell
git clone https://github.com/<your_user>/<your_repository> ~/.config/nvim
git clone https://github.com/nisavid/astronvim-config ~/.config/nvim
```

#### Start Neovim
Expand Down

0 comments on commit 1e12780

Please sign in to comment.