Skip to content

Commit 1e3ac79

Browse files
restrayTimothée Belhomme
authored andcommitted
Merge pull request nvim-lua#283 from nPHYN1T3/master
A bit of clarification
2 parents 350e8c9 + 6949c07 commit 1e3ac79

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,37 @@ A starting point for Neovim that is:
1111

1212
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.
1313

14+
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.
15+
1416
Distribution Alternatives:
1517
- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
1618

1719
### Installation
1820

19-
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.
21+
* Backup your previous configuration (if any exists)
22+
23+
### Archive Installation
24+
* On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP.
25+
* Extract the archive to:
26+
`~/.config/nvim` (Linux)
27+
`~/.config/nvim` (MacOS)
28+
`%userprofile%\AppData\Local\nvim-data\` (Windows)
29+
* 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.
30+
31+
### GIT Clone Installation
32+
* From a terminal cd/dir to:
33+
`~/.config/nvim` (Linux)
34+
`~/.config/nvim` (MacOS)
35+
`%userprofile%\AppData\Local\nvim-data\` (Windows)
36+
37+
* run: git clone https://github.com/nvim-lua/kickstart.nvim.git OR: gh repo clone nvim-lua/kickstart.nvim
38+
* Run neovim (from terminal or shortcut) and allow the kickstart process to download files and set up the basics.
39+
* Once the setup is complete restart Neovim.
40+
* **You're ready to go!**
2041

21-
* Backup your previous configuration
22-
* (Recommended) Fork this repo (so that you have your own copy that you can modify).
23-
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `~/AppData/Local/nvim/` (Windows)
42+
* (Recommended/Optional) Fork this repo (so that you have your own copy that you can modify).
43+
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `%userprofile%\AppData\Local\nvim-data\` (Windows)
2444
* 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
25-
* Start Neovim (`nvim`) and allow `lazy.nvim` to complete installation.
26-
* Restart Neovim
27-
* **You're ready to go!**
2845

2946
Additional system requirements:
3047
- 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
112129
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
113130
* Are there any cool videos about this plugin?
114131
* Current iteration of kickstart (coming soon)
115-
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s).
132+
* 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.
116133

117134
### Windows Installation
118135

0 commit comments

Comments
 (0)