aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDamjan 9000 <damjan.9000@gmail.com>2023-11-03 19:04:25 +0100
committerDamjan 9000 <damjan.9000@gmail.com>2023-11-03 20:55:42 +0100
commit1ad1ec250907acd6e1c593f9990eb61430aa7c74 (patch)
treefe688e3eb49d7a08b7281f7e10b6ebc29fbca89e /README.md
parent99acb843ac9b0470ca5e1a3b0f8561979c5d5e19 (diff)
README.md: Added a FAQ: why is init.lua a single file
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9652d70..1f8e6f4 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,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