summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Patti <feoh@feoh.org>2023-04-26 12:22:56 -0400
committerGitHub <noreply@github.com>2023-04-26 12:22:56 -0400
commitac31b67aeeba0b603e52a45ffac89fe327aec395 (patch)
treeb02f9fa003ea7af43ad753a2ccaa58a3c7d8bf50 /README.md
parent7e0a1675d23f96b07a964ca9cf9aaa240bea123b (diff)
parentdf10841febe952c3482da7ce54233eea6cf02905 (diff)
Merge pull request #283 from nPHYN1T3/master
A bit of clarification
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 25 insertions, 8 deletions
diff --git a/README.md b/README.md
index 21fcab3..02df1b8 100644
--- a/README.md
+++ b/README.md
@@ -11,20 +11,37 @@ 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)
+ `~/.config/nvim` (MacOS)
+ `%userprofile%\AppData\Local\nvim-data\` (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.
+
+### GIT Clone Installation
+* From a terminal cd/dir to:
+ `~/.config/nvim` (Linux)
+ `~/.config/nvim` (MacOS)
+ `%userprofile%\AppData\Local\nvim-data\` (Windows)
+
+* run: git clone https://github.com/nvim-lua/kickstart.nvim.git OR: gh repo clone nvim-lua/kickstart.nvim
+* Run neovim (from terminal or shortcut) and allow the kickstart process to download files and set up the basics.
+* Once the setup is complete restart Neovim.
+* **You're ready to go!**
-* 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)
+* (Recommended/Optional) 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 `%userprofile%\AppData\Local\nvim-data\` (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
-* Start Neovim (`nvim`) and allow `lazy.nvim` to complete installation.
-* Restart Neovim
-* **You're ready to go!**
Additional system requirements:
- Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
@@ -112,7 +129,7 @@ Each PR, especially those which increase the line count, should have a descripti
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
* Are there any cool videos about this plugin?
* Current iteration of kickstart (coming soon)
- * Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s).
+ * Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works.
### Windows Installation