@@ -23,24 +23,22 @@ If you are experiencing issues, please make sure you have the latest versions.
23
23
24
24
External Requirements:
25
25
- Basic utils: ` git ` , ` make ` , ` unzip ` , C Compiler (` gcc ` )
26
- - [ ripgrep] ( https://github.com/BurntSushi/ripgrep#installation ) ,
27
- [ fd-find] ( https://github.com/sharkdp/fd#installation )
28
- - Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
26
+ - [ ripgrep] ( https://github.com/BurntSushi/ripgrep#installation )
27
+ - Clipboard tool (xclip/xsel/win32yank or other depending on platform)
29
28
- A [ Nerd Font] ( https://www.nerdfonts.com/ ) : optional, provides various icons
30
29
- if you have it set ` vim.g.have_nerd_font ` in ` init.lua ` to true
31
- - Emoji fonts (Ubuntu only, and only if you want emoji!) ` sudo apt install fonts-noto-color-emoji `
32
30
- Language Setup:
33
31
- If you want to write Typescript, you need ` npm `
34
32
- If you want to write Golang, you will need ` go `
35
33
- etc.
36
34
37
- > [ ! NOTE]
35
+ > ** NOTE**
38
36
> See [ Install Recipes] ( #Install-Recipes ) for additional Windows and Linux specific notes
39
37
> and quick install snippets
40
38
41
39
### Install Kickstart
42
40
43
- > [ ! NOTE]
41
+ > ** NOTE**
44
42
> [ Backup] ( #FAQ ) your previous configuration (if any exists)
45
43
46
44
Neovim's configurations are located under the following paths, depending on your OS:
@@ -57,17 +55,16 @@ Neovim's configurations are located under the following paths, depending on your
57
55
so that you have your own copy that you can modify, then install by cloning the
58
56
fork to your machine using one of the commands below, depending on your OS.
59
57
60
- > [ ! NOTE]
61
- > Your fork's URL will be something like this:
58
+ > ** NOTE**
59
+ > Your fork's url will be something like this:
62
60
> ` https://github.com/<your_github_username>/kickstart.nvim.git `
63
61
64
62
You likely want to remove ` lazy-lock.json ` from your fork's ` .gitignore ` file
65
63
too - it's ignored in the kickstart repo to make maintenance easier, but it's
66
- [ recommended to track it in version control] ( https://lazy.folke.io/usage/lockfile ) .
64
+ [ recommmended to track it in version control] ( https://lazy.folke.io/usage/lockfile ) .
67
65
68
66
#### Clone kickstart.nvim
69
-
70
- > [ !NOTE]
67
+ > ** NOTE**
71
68
> If following the recommended step above (i.e., forking the repo), replace
72
69
> ` nvim-lua ` with ` <your_github_username> ` in the commands below
73
70
@@ -104,27 +101,22 @@ nvim
104
101
```
105
102
106
103
That's it! Lazy will install all the plugins you have. Use ` :Lazy ` to view
107
- the current plugin status. Hit ` q ` to close the window.
108
-
109
- #### Read The Friendly Documentation
104
+ current plugin status. Hit ` q ` to close the window.
110
105
111
106
Read through the ` init.lua ` file in your configuration folder for more
112
107
information about extending and exploring Neovim. That also includes
113
108
examples of adding popularly requested plugins.
114
109
115
- > [ !NOTE]
116
- > For more information about a particular plugin check its repository's documentation.
117
-
118
110
119
111
### Getting Started
120
112
121
113
[ The Only Video You Need to Get Started with Neovim] ( https://youtu.be/m8C0Cq9Uv9o )
122
114
123
115
### FAQ
124
116
125
- * What should I do if I already have a pre-existing Neovim configuration?
117
+ * What should I do if I already have a pre-existing neovim configuration?
126
118
* You should back it up and then delete all associated files.
127
- * This includes your existing init.lua and the Neovim files in ` ~/.local `
119
+ * This includes your existing init.lua and the neovim files in ` ~/.local `
128
120
which can be deleted with ` rm -rf ~/.local/share/nvim/ `
129
121
* Can I keep my existing configuration in parallel to kickstart?
130
122
* Yes! You can use [ NVIM_APPNAME] ( https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME ) ` =nvim-NAME `
@@ -143,7 +135,7 @@ examples of adding popularly requested plugins.
143
135
* The main purpose of kickstart is to serve as a teaching tool and a reference
144
136
configuration that someone can easily use to `git clone` as a basis for their own.
145
137
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
146
- into smaller parts. A fork of kickstart that does this while maintaining the
138
+ into smaller parts. A fork of kickstart that does this while maintaining the
147
139
same functionality is available here:
148
140
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
149
141
* Discussions on this topic can be found here:
@@ -182,7 +174,7 @@ run in cmd as **admin**:
182
174
winget install --accept-source-agreements chocolatey.chocolatey
183
175
```
184
176
185
- 2 . install all requirements using choco, exit the previous cmd and
177
+ 2 . install all requirements using choco, exit previous cmd and
186
178
open a new one so that choco path is set, and run in cmd as ** admin** :
187
179
```
188
180
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
@@ -215,14 +207,14 @@ sudo apt update
215
207
sudo apt install make gcc ripgrep unzip git xclip curl
216
208
217
209
# Now we install nvim
218
- curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64 .tar.gz
219
- sudo rm -rf /opt/nvim-linux-x86_64
220
- sudo mkdir -p /opt/nvim-linux-x86_64
221
- sudo chmod a+rX /opt/nvim-linux-x86_64
222
- sudo tar -C /opt -xzf nvim-linux-x86_64 .tar.gz
210
+ curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64 .tar.gz
211
+ sudo rm -rf /opt/nvim-linux64
212
+ sudo mkdir -p /opt/nvim-linux64
213
+ sudo chmod a+rX /opt/nvim-linux64
214
+ sudo tar -C /opt -xzf nvim-linux64 .tar.gz
223
215
224
216
# make it available in /usr/local/bin, distro installs to /usr/bin
225
- sudo ln -sf /opt/nvim-linux-x86_64 /bin/nvim /usr/local/bin/
217
+ sudo ln -sf /opt/nvim-linux64 /bin/nvim /usr/local/bin/
226
218
```
227
219
</details >
228
220
<details ><summary >Fedora Install Steps</summary >
0 commit comments