You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+46-29Lines changed: 46 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,35 +20,52 @@ Distribution Alternatives:
20
20
21
21
### Installation
22
22
23
-
* Backup your previous configuration (if any exists)
24
-
25
-
### Archive Installation
26
-
* On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP.
27
-
* Extract the archive to:
28
-
`~/.config/nvim` (Linux)
29
-
`~/.config/nvim` (MacOS)
30
-
`%userprofile%\AppData\Local\nvim\` (Windows)
31
-
* 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 Neovim (from terminal or shortcut) and allow lazy.nvim to download files and set up the basics.
41
-
* Once the setup is complete, restart Neovim.
42
-
***You're ready to go!**
43
-
44
-
* (Recommended/Optional) Fork this repo (so that you have your own copy that you can modify).
45
-
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `%userprofile%\AppData\Local\nvim\` (Windows)
46
-
* 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
47
-
48
-
Additional system requirements:
49
-
- Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
50
-
-[ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
51
-
- See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
23
+
> **NOTE**
24
+
> [Backup](#FAQ) your previous configuration (if any exists)
25
+
26
+
Requirements:
27
+
* Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
28
+
*[ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
29
+
* See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
30
+
31
+
Neovim's configurations are located under the following paths, depending on your OS:
32
+
33
+
| OS | PATH |
34
+
| :- | :--- |
35
+
| Linux |`~/.config/nvim`|
36
+
| MacOS |`~/.config/nvim`|
37
+
| Windows |`%userprofile%\AppData\Local\nvim\`|
38
+
39
+
#### Archive Installation
40
+
41
+
* On the home/landing page for the project find the green "`<> CODE`" button click it and select `Local > Download ZIP`.
42
+
* Extract the archive to the appropriate configuration path.
43
+
* 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`.
44
+
45
+
#### Git Clone Installation
46
+
47
+
From a terminal `cd`/`dir` to the configuration path and then run:
Run the following command and then **you are ready to go**!
58
+
59
+
```sh
60
+
nvim --headless "+Lazy! sync" +qa
61
+
```
62
+
63
+
### Recommended Optional
64
+
65
+
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo (so that you have your own copy that you can modify) and then installing you can install to your machine using the methods above.
66
+
67
+
> **NOTE**
68
+
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
0 commit comments