@@ -23,16 +23,42 @@ External Requirements:
2323 - If you want to write Golang, you will need ` go `
2424 - etc.
2525
26- Basic utils: git, make, unzip, C Compiler (gcc)
27- ripgrep
28- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
29- A Nerd Font: optional, provides various icons
30- if you have it set vim.g.have_nerd_font in init.lua to true
31- Language Setup:
32- If you want to write Typescript, you need npm
33- If you want to write Golang, you will need go
34- etc.
26+ > [ !NOTE]
27+ > See [ Install Recipes] ( #Install-Recipes ) for additional Windows and Linux specific notes
28+ > and quick install snippets
29+
30+ ### Install Kickstart
31+
32+ > [ !NOTE]
33+ > [ Backup] ( #FAQ ) your previous configuration (if any exists)
34+
35+ Neovim's configurations are located under the following paths, depending on your OS:
36+
37+ | OS | PATH |
38+ | :- | :--- |
39+ | Linux, MacOS | ` $XDG_CONFIG_HOME/nvim ` , ` ~/.config/nvim ` |
40+ | Windows (cmd)| ` %localappdata%\nvim\ ` |
41+ | Windows (powershell)| ` $env:LOCALAPPDATA\nvim\ ` |
42+
43+ #### Recommended Step
3544
45+ [ Fork] ( https://docs.github.com/en/get-started/quickstart/fork-a-repo ) this repo
46+ so that you have your own copy that you can modify, then install by cloning the
47+ fork to your machine using one of the commands below, depending on your OS.
48+
49+ > [ !NOTE]
50+ > Your fork's URL will be something like this:
51+ > ` https://github.com/<your_github_username>/kickstart.nvim.git `
52+
53+ You likely want to remove ` lazy-lock.json ` from your fork's ` .gitignore ` file
54+ too - it's ignored in the kickstart repo to make maintenance easier, but it's
55+ [ recommended to track it in version control] ( https://lazy.folke.io/usage/lockfile ) .
56+
57+ #### Clone kickstart.nvim
58+
59+ > [ !NOTE]
60+ > If following the recommended step above (i.e., forking the repo), replace
61+ > ` nvim-lua ` with ` <your_github_username> ` in the commands below
3662
3763#### Clone
3864<details ><summary > Linux and Mac </summary >
0 commit comments