README: complete revamp
This commit is contained in:
parent
96b5fdaa77
commit
7e4cb5a974
4 changed files with 56 additions and 155 deletions
56
README.md
Normal file
56
README.md
Normal file
|
@ -0,0 +1,56 @@
|
|||

|
||||
|
||||
[](https://travis-ci.org/mhinz/vim-startify)
|
||||
[](https://gitter.im/mhinz/mhinz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://raw.githubusercontent.com/mhinz/vim-startify/master/LICENSE)
|
||||
|
||||
---
|
||||
|
||||
This plugin provides a start screen for Vim and Neovim.
|
||||
|
||||
It provides **dynamically created headers or footers** and uses configurable
|
||||
lists to show **recently used or bookmarked files** and **persistent sessions**.
|
||||
All of this can be accessed in a **simple to use menu** that allows to open
|
||||
single or multiple entries.
|
||||
|
||||
Startify doesn't get in your way and works out-of-the-box, but provides many
|
||||
options for fine-grained customization.
|
||||
|
||||
---
|
||||
|
||||
- [Installation & Documentation](#installation-and-documentation)
|
||||
- [Screenshot](#screenshot)
|
||||
- [Author and Feedback](#author-and-feedback)
|
||||
|
||||
---
|
||||
|
||||
## Installation and Documentation
|
||||
|
||||
Use your favorite plugin manager.
|
||||
|
||||
Using [vim-plug](https://github.com/junegunn/vim-plug):
|
||||
|
||||
Plug 'mhinz/vim-startify'
|
||||
|
||||
It works without any configuration, but you might want to look into the
|
||||
documentation for further customization:
|
||||
|
||||
:h startify
|
||||
:h startify-faq
|
||||
|
||||
## Screenshot
|
||||
|
||||

|
||||
That's it. A fancy start screen for Vim. _(almost all visible features enabled - freely customizable)_
|
||||
|
||||
## Author and Feedback
|
||||
|
||||
If you like my plugins, please star them on Github. It's a great way of getting
|
||||
feedback. Same goes for issues reports or feature requests.
|
||||
|
||||
Contact:
|
||||
[Mail](mailto:mh.codebro@gmail.com) |
|
||||
[Twitter](https://twitter.com/_mhinz_) |
|
||||
[Gitter](https://gitter.im/mhinz/mhinz)
|
||||
|
||||
_Get your Vim on!_
|
Loading…
Add table
Add a link
Reference in a new issue