diff options
| author | Damjan 9000 <damjan.9000@gmail.com> | 2023-11-03 19:04:25 +0100 |
|---|---|---|
| committer | Damjan 9000 <damjan.9000@gmail.com> | 2023-11-03 20:55:42 +0100 |
| commit | e2f4c3b652408829a60e2aea5fd0070c226b7a8d (patch) | |
| tree | 2df7943845d18061ec6bf21892b64f4d437ec818 | |
| parent | ab6354e6fe6dda318362cc5133dc5dc342969f0f (diff) | |
| download | dots-e2f4c3b652408829a60e2aea5fd0070c226b7a8d.tar.gz | |
README.md: Added a FAQ: why is init.lua a single file
| -rw-r--r-- | nvim/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/nvim/README.md b/nvim/README.md index e2d9ea8..7f54ce8 100644 --- a/nvim/README.md +++ b/nvim/README.md @@ -168,6 +168,16 @@ Each PR, especially those which increase the line count, should have a descripti * Are there any cool videos about this plugin? * Current iteration of kickstart (coming soon) * 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. +* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files? + * The main purpose of kickstart is to serve as a teaching tool and a reference + configuration that someone can easily `git clone` as a basis for their own. + As you progress in learning Neovim and Lua, you might consider splitting `init.lua` + into smaller parts. A fork of kickstart that does this while maintaining the exact + same functionality is available here: + * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim) + * Discussions on this topic can be found here: + * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218) + * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473) ### Windows Installation |