Skip to content

Commit c638351

Browse files
dam9000Aslaii
authored and
Aslaii
committed
README: wrap long lines (nvim-lua#784)
Initial Setup for Kickstart
1 parent 4c02e29 commit c638351

File tree

2 files changed

+35
-19
lines changed

2 files changed

+35
-19
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?

init.lua

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ vim.g.mapleader = ' '
9191
vim.g.maplocalleader = ' '
9292

9393
-- Set to true if you have a Nerd Font installed
94-
vim.g.have_nerd_font = false
94+
vim.g.have_nerd_font = true
9595

9696
-- [[ Setting options ]]
9797
-- See `:help vim.opt`
@@ -102,7 +102,7 @@ vim.g.have_nerd_font = false
102102
vim.opt.number = true
103103
-- You can also add relative line numbers, to help with jumping.
104104
-- Experiment for yourself to see if you like it!
105-
-- vim.opt.relativenumber = true
105+
vim.opt.relativenumber = true
106106

107107
-- Enable mouse mode, can be useful for resizing splits for example!
108108
vim.opt.mouse = 'a'
@@ -548,7 +548,7 @@ require('lazy').setup({
548548
-- https://github.com/pmizio/typescript-tools.nvim
549549
--
550550
-- But for many setups, the LSP (`tsserver`) will work just fine
551-
-- tsserver = {},
551+
tsserver = {},
552552
--
553553

554554
lua_ls = {
@@ -619,7 +619,7 @@ require('lazy').setup({
619619
--
620620
-- You can use a sub-list to tell conform to run *until* a formatter
621621
-- is found.
622-
-- javascript = { { "prettierd", "prettier" } },
622+
javascript = { { 'prettierd', 'prettier' } },
623623
},
624624
},
625625
},
@@ -644,12 +644,12 @@ require('lazy').setup({
644644
-- `friendly-snippets` contains a variety of premade snippets.
645645
-- See the README about individual language/framework/plugin snippets:
646646
-- https://github.com/rafamadriz/friendly-snippets
647-
-- {
648-
-- 'rafamadriz/friendly-snippets',
649-
-- config = function()
650-
-- require('luasnip.loaders.from_vscode').lazy_load()
651-
-- end,
652-
-- },
647+
{
648+
'rafamadriz/friendly-snippets',
649+
config = function()
650+
require('luasnip.loaders.from_vscode').lazy_load()
651+
end,
652+
},
653653
},
654654
},
655655
'saadparwaiz1/cmp_luasnip',
@@ -836,7 +836,7 @@ require('lazy').setup({
836836
--
837837
-- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going.
838838
-- For additional information, see `:help lazy.nvim-lazy.nvim-structuring-your-plugins`
839-
-- { import = 'custom.plugins' },
839+
{ import = 'custom.plugins' },
840840
}, {
841841
ui = {
842842
-- If you are using a Nerd Font: set icons to an empty table which will use the

0 commit comments

Comments
 (0)