aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Patti <feoh@feoh.org>2024-02-03 19:15:25 -0500
committerGitHub <noreply@github.com>2024-02-03 19:15:25 -0500
commit5d2d81b1ea7373a585fcf02e23296fe1f8bc58e7 (patch)
tree3253d19de22372153118b09441e89d3c0a16dcb5 /README.md
parentbc4ad1218b908ec4efc3b0f6ea6e3cb4940b0084 (diff)
Fixes #607. Add hints for new neovim users to learn how to learn. (#615)
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
index a4c6bd7..b7fe337 100644
--- a/README.md
+++ b/README.md
@@ -192,3 +192,55 @@ This requires:
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```
+### Hints And Tips For New Neovimmers
+
+Neovim is a very rich and powerful environment, but it can also feel a bit
+intimidating for new users trying to find their way around, especially if
+they're coming from other environments like Visual Studio Code or a traditional
+IDE.
+
+There's no way this README can provide you with everything you need to know, but
+here are a few tips so you can learn how to learn.
+
+### Use The Help, Luke!
+
+Neovim's help system is incredibly thorough and extensive. You should really
+take a moment to get comfortable navigating through help topics, going back and
+forth, navigating the menus, etc. This won't just help you read the help, it
+will empower you in the rest of your Neovim journey.
+
+You can double click on a topic to drill down, and hit Ctrl-o (Hold down the
+Control key and the 'o' key) to go back.
+
+Read the first page you get when you run :help carefully. it will serve you
+well.
+
+You can also get help on a particular thing by typing ":help <topic>".
+
+Like, let's say we want to learn more about folding, just type ":help folding".
+
+### To The Telescope!
+
+One of the more powerful features you get by installing this project is the
+brilliant Telescope plugin co-written by @tjdevries.
+
+Take a minute to browse through ":help telescope" and get a sense for all the
+amazing superpowers you've gained.
+
+In particular, there are two Telescope features that are incredible for helping
+you understand how to do a particular thing or how to configure a particular
+feature.
+
+If you're not sure what to look for, try ":Telescope help_tags". Let's say we
+want to configure Neovim to automatically word wrap. We might type ":Telescope
+help_tags" and then type w, r, a, p. Notice how the list of results changes with
+each new letter you type? When you're done you've got a screen full of topics
+involving word wrap.
+
+Another common question is "What keys do I hit to make a thing happen?". To get
+an answer, one way is to use ":Telescope keymaps". You'll get the same list of
+results that changes to adapt with each new key you press.
+
+With these hints in mind you should be in good shape to get learning. Remember,
+you are on a journey of discovery here, adapting your programming environment to
+your needs. It will take effort, but the rewards are worth it! :)