Skip to content

Commit a6614a4

Browse files
authored
Fixes nvim-lua#607. Add hints for new neovim users to learn how to learn. (nvim-lua#615)
1 parent eb0a425 commit a6614a4

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,55 @@ This requires:
192192
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
193193
```
194194

195+
### Hints And Tips For New Neovimmers
196+
197+
Neovim is a very rich and powerful environment, but it can also feel a bit
198+
intimidating for new users trying to find their way around, especially if
199+
they're coming from other environments like Visual Studio Code or a traditional
200+
IDE.
201+
202+
There's no way this README can provide you with everything you need to know, but
203+
here are a few tips so you can learn how to learn.
204+
205+
### Use The Help, Luke!
206+
207+
Neovim's help system is incredibly thorough and extensive. You should really
208+
take a moment to get comfortable navigating through help topics, going back and
209+
forth, navigating the menus, etc. This won't just help you read the help, it
210+
will empower you in the rest of your Neovim journey.
211+
212+
You can double click on a topic to drill down, and hit Ctrl-o (Hold down the
213+
Control key and the 'o' key) to go back.
214+
215+
Read the first page you get when you run :help carefully. it will serve you
216+
well.
217+
218+
You can also get help on a particular thing by typing ":help <topic>".
219+
220+
Like, let's say we want to learn more about folding, just type ":help folding".
221+
222+
### To The Telescope!
223+
224+
One of the more powerful features you get by installing this project is the
225+
brilliant Telescope plugin co-written by @tjdevries.
226+
227+
Take a minute to browse through ":help telescope" and get a sense for all the
228+
amazing superpowers you've gained.
229+
230+
In particular, there are two Telescope features that are incredible for helping
231+
you understand how to do a particular thing or how to configure a particular
232+
feature.
233+
234+
If you're not sure what to look for, try ":Telescope help_tags". Let's say we
235+
want to configure Neovim to automatically word wrap. We might type ":Telescope
236+
help_tags" and then type w, r, a, p. Notice how the list of results changes with
237+
each new letter you type? When you're done you've got a screen full of topics
238+
involving word wrap.
239+
240+
Another common question is "What keys do I hit to make a thing happen?". To get
241+
an answer, one way is to use ":Telescope keymaps". You'll get the same list of
242+
results that changes to adapt with each new key you press.
243+
244+
With these hints in mind you should be in good shape to get learning. Remember,
245+
you are on a journey of discovery here, adapting your programming environment to
246+
your needs. It will take effort, but the rewards are worth it! :)

0 commit comments

Comments
 (0)