Skip to content

Commit 1ad1ec2

Browse files
committed
README.md: Added a FAQ: why is init.lua a single file
1 parent 99acb84 commit 1ad1ec2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,16 @@ Each PR, especially those which increase the line count, should have a descripti
161161
* Are there any cool videos about this plugin?
162162
* Current iteration of kickstart (coming soon)
163163
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works as specified. Please follow the install instructions in this file instead as they're up to date.
164+
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
165+
* The main purpose of kickstart is to serve as a teaching tool and a reference
166+
configuration that someone can easily `git clone` as a basis for their own.
167+
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
168+
into smaller parts. A fork of kickstart that does this while maintaining the exact
169+
same functionality is available here:
170+
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
171+
* Discussions on this topic can be found here:
172+
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
173+
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
164174
165175
### Windows Installation
166176

0 commit comments

Comments
 (0)