Best-README-Template VS cheatsheet.nvim

othneildrew/Best-README-Template is the basis for this creation.

I use this template to help get a jumpstart.

Best-README-Template

A README.md template: https://github.com/othneildrew/Best-README-Template

Every repository should contain a Readme file with (at least) a project description and instructions on how to set up the project, run it, run the tests, and which technologies are used. Here is the link to the template example.

I use a RDD approach - README Driven Development. (I think some would call this Documentation Driven Development [https://gist.github.com/zsup/9434452], but its way more simplified, in order to get started quicker.) I like to use a good template so I can track my progress. As more features are added, the template gets more filled in. And tbh, i get a bit more driven when i see more and more of the template filled in with screenshots, logos, guides, etc. A good template for me is https://github.com/othneildrew/Best-README-Template.

See the open issues for a full list of proposed features (and known issues).

othneildrew has a robust readme template, and DomPizzie has a simple one.

Here’s a great template to get started!

[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors

I tried to use which-key but just found it quite confusing how to set it up and to provide me with customised information. I opted for something much simpler Cheatsheet plugin, which is just a reference list.

If you plan on using neovim, these plugins are extremely helpful for commands you use less often: https://github.com/folke/which-key.nvim https://github.com/sudormrfbin/cheatsheet.nvim

this plugin allows you to display your custom command list in a floating window by typing ?

The show keybinding thing already exists. I believe :Telescope keymaps also does that? Check this one out https://github.com/sudormrfbin/cheatsheet.nvim, you can define your own list and stuff

Neat stuff! Nowadays, I mostly use Cheatsheet[1] to quickly look up things I want to do, but resources like this are always nice for learning new stuff you didn't know about.

One piece of feedback is that I would include "+p and "+yy in the copy and paste section. I feel like that's the first place where people will go to look for "How to copy and paste using clipboard".

[1] https://github.com/sudormrfbin/cheatsheet.nvim

Cheatsheet: for those of us who dont remember or dont know that vim command we need right now.

You could use the Cheatsheet plugin. I use it to easily access the keybinding list of my most used plugins, but you can store anything in it.

cheatsheet.nvim is a neovim plugin that you can use to display a cheatsheet from within neovim, optionally using Telescope (falling back to showing them in a floating window).