Add vim integration to readme

This patch adds information about calling rusty-man from vim to the
readme.
This commit is contained in:
Robin Krahl 2020-07-24 22:47:13 +02:00
parent e69e4af31c
commit 1adeafe909
No known key found for this signature in database
GPG Key ID: 8E9B0870524F69D8

View File

@ -61,6 +61,15 @@ rusty-man should run on all platforms supported by [`crossterm`][]. If you
have trouble running rusty-man on your platform or if you want to help porting
rusty-man to other platforms, please let me know.
## Integrations
### vim
You can set rusty-man as the keyword program with `set keywordprg=rusty-man`
and then use `K` to open the documentation for the item under the cursor. If
you want to apply this setting for all Rust files, add it to the
`ftplugin/rust.vim` file in your vim runtime directory (e. g. `~/.vim`).
## Contributing
Contributions to this project are very welcome! You can contribute by writing