diff options
Diffstat (limited to '')
| -rw-r--r-- | dot_config/nvim/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/dot_config/nvim/README.md b/dot_config/nvim/README.md new file mode 100644 index 0000000..71d48de --- /dev/null +++ b/dot_config/nvim/README.md @@ -0,0 +1,34 @@ +# AstroNvim Template + +**NOTE:** This is for AstroNvim v5+ + +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 +``` + +#### Start Neovim + +```shell +nvim +``` |