docs(init.lua): improve readability

- grammar
- punctuation
pull/896/head
vladislav doster 4 weeks ago committed by GitHub
parent b7d5cc8f42
commit e9b7a42401
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -24,15 +24,15 @@ What is Kickstart?
Kickstart.nvim is *not* a distribution.
Kickstart.nvim is a starting point for your own configuration.
Kickstart.nvim is a starting point for your configuration.
The goal is that you can read every line of code, top-to-bottom, understand
what your configuration is doing, and modify it to suit your needs.
Once you've done that, you can start exploring, configuring and tinkering to
make Neovim your own! That might mean leaving Kickstart just the way it is for a while
Once done, you can start exploring, configuring, and tinkering to
make Neovim your own! That might mean leaving Kickstart just as it is for a while
or immediately breaking it into modular pieces. It's up to you!
If you don't know anything about Lua, I recommend taking some time to read through
If you don't know anything about Lua, I recommend reading through
a guide. One possible example which will only take 10-15 minutes:
- https://learnxinyminutes.com/docs/lua/
@ -43,7 +43,7 @@ What is Kickstart?
Kickstart Guide:
TODO: The very first thing you should do is to run the command `:Tutor` in Neovim.
TODO: The first thing you should do is run the command `:Tutor` in Neovim.
If you don't know what this means, type the following:
- <escape key>
@ -58,13 +58,13 @@ Kickstart Guide:
Next, run AND READ `:help`.
This will open up a help window with some basic information
about reading, navigating and searching the builtin help documentation.
about reading, navigating, and searching the built-in help documentation.
This should be the first place you go to look when you're stuck or confused
This should be the first place you go to check when you need help or clarification
with something. It's one of my favorite Neovim features.
MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation,
which is very useful when you're not exactly sure of what you're looking for.
which is very useful when you're unsure what you're looking for.
I have left several `:help X` comments throughout the init.lua
These are hints about where to find more information about the relevant settings,
@ -72,16 +72,16 @@ Kickstart Guide:
NOTE: Look for lines like this
Throughout the file. These are for you, the reader, to help you understand what is happening.
Throughout the file. These are for the reader to help you understand what is happening.
Feel free to delete them once you know what you're doing, but they should serve as a guide
for when you are first encountering a few different constructs in your Neovim config.
for when you first encounter a few different constructs in your Neovim config.
If you experience any errors while trying to install kickstart, run `:checkhealth` for more info.
If you experience errors while installing Kickstart, run `:checkhealth` for more info.
I hope you enjoy your Neovim journey,
- TJ
P.S. You can delete this when you're done too. It's your config now! :)
P.S. You can delete this when you're done, too. It's your config now! :)
--]]
-- Set <space> as the leader key

Loading…
Cancel
Save