Skip to content

Commit 76f6dd3

Browse files
committed
Merge remote-tracking branch 'upstream/master'
* upstream/master: (72 commits) README: wrap long lines (nvim-lua#784) Update README.md (nvim-lua#781) Add nvim-nio as dependency for nvim-dap-ui (nvim-lua#774) Some suggestions and capitalised a few words (nvim-lua#771) feat: add linter plugin (nvim-lua#699) assign table to filetype in lua_ls config comment (nvim-lua#770) README: additional install recipes for various OS (nvim-lua#767) conform: disable autoformat on save for specified filetypes (nvim-lua#694) Update README.md (nvim-lua#763) fix: disable ts indenting for Ruby doc: add note about advanced luasnip features Move friendly snippets to dependencies of LuaSnip (nvim-lua#759) Add <C-b>/<C-f> cmp mapping to scroll cmp docs (nvim-lua#750) doc: add info about timeoutlen (nvim-lua#691) Revert "Use `cmp-nvim-lua` as `nvim-cmp` source for neovim Lua API (nvim-lua#696)" (nvim-lua#755) Use `cmp-nvim-lua` as `nvim-cmp` source for neovim Lua API (nvim-lua#696) Added folke/neodev.nvim for proper nvim api completion and annotation (nvim-lua#754) chore: rename <C-T> to <C-t> for consistency (nvim-lua#719) feat: allow treesitter defaults to be overwritten from custom directory (nvim-lua#732) README.md: update neo-tree example - remove legacy setting (nvim-lua#744) ...
2 parents b59bc73 + dbba54c commit 76f6dd3

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,22 @@ Neovim's configurations are located under the following paths, depending on your
4848

4949
### Install Kickstart
5050

51-
Clone kickstart.nvim:
51+
#### Recommended Step
52+
53+
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
54+
so that you have your own copy that you can modify, then install by cloning the
55+
fork to your machine using one of the commands below, depending on your OS.
56+
57+
58+
59+
> **NOTE**
60+
> Your fork's url will be something like this:
61+
> `https://github.com/<your_github_username>/kickstart.nvim.git`
62+
63+
#### Clone kickstart.nvim
64+
> **NOTE**
65+
> If following the recommended step above (i.e., forking the repo), replace
66+
> `nvim-lua` with `<your_github_username>` in the commands below
5267
5368
<details><summary> Linux and Mac </summary>
5469

@@ -88,18 +103,6 @@ current plugin status.
88103
Read through the `init.lua` file in your configuration folder for more
89104
information about extending and exploring Neovim.
90105

91-
### Getting Started
92-
93-
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
94-
95-
### Recommended Steps
96-
97-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
98-
(so that you have your own copy that you can modify) and then install. You
99-
can install it on your machine using the methods above.
100-
101-
> **NOTE**
102-
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
103106

104107
#### Examples of adding popularly requested plugins
105108

@@ -108,7 +111,9 @@ NOTE: You'll need to uncomment the line in the init.lua that turns on loading cu
108111
<details>
109112
<summary>Adding autopairs</summary>
110113

111-
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).
114+
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
115+
and enable it on startup. For more information, see documentation for
116+
[lazy.nvim](https://github.com/folke/lazy.nvim).
112117

113118
In the file: `lua/custom/plugins/autopairs.lua`, add:
114119

@@ -136,7 +141,9 @@ return {
136141
<details>
137142
<summary>Adding a file tree plugin</summary>
138143

139-
This will install the tree plugin and add the command `:Neotree` for you. For more information, see the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
144+
This will install the tree plugin and add the command `:Neotree` for you.
145+
For more information, see the documentation at
146+
[neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
140147

141148
In the file: `lua/custom/plugins/filetree.lua`, add:
142149

@@ -159,17 +166,27 @@ return {
159166

160167
</details>
161168

169+
### Getting Started
170+
171+
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
172+
162173
### FAQ
163174

164175
* What should I do if I already have a pre-existing neovim configuration?
165176
* You should back it up and then delete all associated files.
166-
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
177+
* This includes your existing init.lua and the neovim files in `~/.local`
178+
which can be deleted with `rm -rf ~/.local/share/nvim/`
167179
* Can I keep my existing configuration in parallel to kickstart?
168-
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example, you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
180+
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
181+
to maintain multiple configurations. For example, you can install the kickstart
182+
configuration in `~/.config/nvim-kickstart` and create an alias:
169183
```
170184
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
171185
```
172-
When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
186+
When you run Neovim using `nvim-kickstart` alias it will use the alternative
187+
config directory and the matching local directory
188+
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
189+
distribution that you would like to try out.
173190
* What if I want to "uninstall" this configuration:
174191
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
175192
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
@@ -258,3 +275,4 @@ sudo dnf install -y gcc make git ripgrep fd-find neovim
258275
```
259276
</details>
260277

278+

0 commit comments

Comments
 (0)