summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornPHYN1T3 <38122105+nPHYN1T3@users.noreply.github.com>2023-04-24 15:21:53 -0600
committerGitHub <noreply@github.com>2023-04-24 15:21:53 -0600
commit2eff982e1ef7b7c1e7a052c5338a4a09bec396cd (patch)
tree001879cf241d307d9d89396886701751ed21db63 /README.md
parent36842aa368cbe3df3059c25db1bd2d15bc731a94 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 21fcab3..52a62fc 100644
--- a/README.md
+++ b/README.md
@@ -11,14 +11,27 @@ A starting point for Neovim that is:
This repo is meant to be used as by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss.
+Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
+
Distribution Alternatives:
- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
### Installation
-Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
+* Backup your previous configuration (if any exists)
+
+### Archive Installation
+* On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP.
+* Extract the archive to:
+ ~/.config/nvim (Linux)
+ ??? (MacOS)
+ ??? (Windows)
+* Ensure your extraction method did not extract with a parent folder. For example in ~/.config/nvim you should have init.lua not another folder called kickstart.nvim.
+* Run nvim and allow the kickstart process to download files and set up the basics.
+
+### GIT Clone Installation
+
-* Backup your previous configuration
* (Recommended) Fork this repo (so that you have your own copy that you can modify).
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `~/AppData/Local/nvim/` (Windows)
* If you don't want to include it as a git repo, you can just clone it and then move the files to this location