aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamjan 9000 <damjan.9000@gmail.com>2024-03-22 09:46:53 +0100
committerDamjan 9000 <damjan.9000@gmail.com>2024-03-22 09:47:09 +0100
commita037d1d4d68a58d135bb976964eee77b18cf4ec8 (patch)
treee41a4e6a5037ab83665913624b6ad198b5debd9d
parent2860431c6dd8f3c05dea424380e4f2afd1c2518d (diff)
parentdbba54cfd81506a20832aade85735bf4dc377b95 (diff)
Merge branch 'upstream' README: wrap long lines
-rw-r--r--README.md32
1 files changed, 24 insertions, 8 deletions
diff --git a/README.md b/README.md
index 00f463e..86ad89c 100644
--- a/README.md
+++ b/README.md
@@ -52,14 +52,20 @@ Neovim's configurations are located under the following paths, depending on your
#### Recommended Step
-[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.
+[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.
+
+
> **NOTE**
-> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart-modular.nvim.git`
+> Your fork's url will be something like this:
+> `https://github.com/<your_github_username>/kickstart-modular.nvim.git`
#### Clone kickstart.nvim
> **NOTE**
-> If following the recommended step above (i.e., forking the repo), replace `dam9000` with `<your_github_username>` in the commands below
+> If following the recommended step above (i.e., forking the repo), replace
+> `dam9000` with `<your_github_username>` in the commands below
<details><summary> Linux and Mac </summary>
@@ -107,7 +113,9 @@ NOTE: You'll need to uncomment the line in the init.lua that turns on loading cu
<details>
<summary>Adding autopairs</summary>
-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).
+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).
In the file: `lua/custom/plugins/autopairs.lua`, add:
@@ -135,7 +143,9 @@ return {
<details>
<summary>Adding a file tree plugin</summary>
-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).
+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).
In the file: `lua/custom/plugins/filetree.lua`, add:
@@ -166,13 +176,19 @@ return {
* What should I do if I already have a pre-existing neovim configuration?
* You should back it up and then delete all associated files.
- * This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
+ * This includes your existing init.lua and the neovim files in `~/.local`
+ which can be deleted with `rm -rf ~/.local/share/nvim/`
* Can I keep my existing configuration in parallel to kickstart?
- * 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:
+ * 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:
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
- 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.
+ 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.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?