Skip to content

Commit 1036049

Browse files
authored
README: wrap long lines (nvim-lua#784)
1 parent fab2f97 commit 1036049

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,20 @@ Neovim's configurations are located under the following paths, depending on your
5050

5151
#### Recommended Step
5252

53-
[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, then install by cloning the fork to your machine using one of the commands below, depending on your OS.
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+
5458

5559
> **NOTE**
56-
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
60+
> Your fork's url will be something like this:
61+
> `https://github.com/<your_github_username>/kickstart.nvim.git`
5762
5863
#### Clone kickstart.nvim
5964
> **NOTE**
60-
> If following the recommended step above (i.e., forking the repo), replace `nvim-lua` with `<your_github_username>` in the commands below
65+
> If following the recommended step above (i.e., forking the repo), replace
66+
> `nvim-lua` with `<your_github_username>` in the commands below
6167
6268
<details><summary> Linux and Mac </summary>
6369

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

108-
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).
109117

110118
In the file: `lua/custom/plugins/autopairs.lua`, add:
111119

@@ -133,7 +141,9 @@ return {
133141
<details>
134142
<summary>Adding a file tree plugin</summary>
135143

136-
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).
137147

138148
In the file: `lua/custom/plugins/filetree.lua`, add:
139149

@@ -164,13 +174,19 @@ return {
164174

165175
* What should I do if I already have a pre-existing neovim configuration?
166176
* You should back it up and then delete all associated files.
167-
* 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/`
168179
* Can I keep my existing configuration in parallel to kickstart?
169-
* 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:
170183
```
171184
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
172185
```
173-
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.
174190
* What if I want to "uninstall" this configuration:
175191
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
176192
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?

0 commit comments

Comments
 (0)