README.md: Added a FAQ: why is init.lua a single file #486
+10
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
feoh
reviewed
Nov 3, 2023
README.md
Outdated
| @@ -161,6 +161,12 @@ 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 copy and paste 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: | |||
There was a problem hiding this comment.
Firstly this definitely belongs here in my book, as this question keeps coming up, and I think yours is a thoughtful treatment and suggested answer that solves the problem for those who care.
I have just a couple tiny suggestions:
- Please consider replacing "copy and paste" with "git clone" because copying and pasting is no longer the write way to install kickstart and we get SOOO MANY PEOPLE coming here from @tjdevries video confused because things are broken I don't want to encourage them :)
- Please consider splitting that very long bullet into separate lines. In Markdown you can make the lines separate and shorter and they'll still render as one line unless you put two empty lines in between.
Thanks much for contributing, I think this will help a lot!
There was a problem hiding this comment.
Done, force pushed the suggested changes.
dam9000
force-pushed
the
pr-faq-single-file
branch
from
025e6da
to
1ad1ec2
Compare
feoh
approved these changes
Nov 3, 2023
antoson
pushed a commit
to antoson/kickstart.nvim
that referenced
this pull request
Nov 6, 2023
README.md: Added a FAQ: why is init.lua a single file
qiuye2015
pushed a commit
to qiuye2015/fjp.nvim
that referenced
this pull request
Dec 10, 2023
README.md: Added a FAQ: why is init.lua a single file
cbmorrell
pushed a commit
to cbmorrell/kickstart-modular.nvim
that referenced
this pull request
Apr 22, 2024
README.md: Added a FAQ: why is init.lua a single file
s-frick
pushed a commit
to s-frick/kickstart.nvim
that referenced
this pull request
Jul 29, 2024
README.md: Added a FAQ: why is init.lua a single file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the PR comment: #473 (comment)
It was suggested that a note would be added to the README regarding the single vs multi file approach of init.lua,
So here is a PR that adds a section in FAQ about the single file vs multi-file approach and a link to the multi-file fork.
Not sure if I formulated it the best, if you have some additional suggestions let me know.
(or close if you feel this does not belong here)