Skip to content

Commit 8e9cac9

Browse files
committed
docs: update README with usage instructions and modular configuration details
1 parent 1dc6568 commit 8e9cac9

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# kickstart.nvim
22

3+
## HOW TO USE IT:
4+
I keep this fork to stay up to date to the last changes on the OG repository.
5+
I will rebase from time to time.
6+
My working branch is "modular-configuration".
7+
I simply switch to it and update init.modular.lua and modules.
8+
Once I've done I simply copy them to my main dotfiles, so they goes like this:
9+
10+
`init.modular.lua` => `$MY_DOTFILES_NVIM_CONF/init.lua`
11+
and
12+
`modules` => `$MY_DOTFILES_NVIM_CONF/modules`
13+
314
## Introduction
415

516
A starting point for Neovim that is:

init.modular.lua

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -248,23 +248,7 @@ rtp:prepend(lazypath)
248248
-- NOTE: Here is where you install your plugins.
249249
require('lazy').setup({
250250

251-
import { 'modules.utils' },
252-
253-
import { 'modules.uxui.gitsigns'},
254-
255-
import { 'modules.uxui.whichkey' },
256-
257-
import { 'modules.finder.telescope' },
258-
259-
import { 'modules.lsp ' },
260-
261-
import { 'modules.formatter.conform' },
262-
263-
import { 'modules.completions.blink' },
264-
265-
import { 'modules.theme' },
266-
267-
import { 'modules.util.mini' },
251+
import { 'modules' },
268252

269253
-- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the
270254
-- init.lua. If you want these files, they are in the repository, so you can just download them and

0 commit comments

Comments
 (0)