summaryrefslogtreecommitdiffstats
path: root/nvim/README.md
diff options
context:
space:
mode:
authorIhsan Tonuzi <115842560+iton0@users.noreply.github.com>2024-12-29 12:00:16 -0500
committerGitHub <noreply@github.com>2024-12-29 12:00:16 -0500
commit7fc11051a84757285cd23faa8d2bda9418c47f2c (patch)
tree84780934648811e80a68f7da546a6f6c05184fd2 /nvim/README.md
parent77e19835bf529573e7b21724bf104b76f307334a (diff)
downloaddots-7fc11051a84757285cd23faa8d2bda9418c47f2c.tar.gz
chore: add pre-issue requirements (#1288)
* chore: add pre-issue requirements Based on #1285 * docs: add header about documentation Based on #1285
Diffstat (limited to 'nvim/README.md')
-rw-r--r--nvim/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/nvim/README.md b/nvim/README.md
index 08cecfa..aa5f4fc 100644
--- a/nvim/README.md
+++ b/nvim/README.md
@@ -103,10 +103,15 @@ nvim
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
the current plugin status. Hit `q` to close the window.
+#### Read The Friendly Documentation
+
Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
+> [!NOTE]
+> For more information about a particular plugin check its repository's documentation.
+
### Getting Started
@@ -135,7 +140,7 @@ examples of adding popularly requested plugins.
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `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
+ into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here: