diff --git a/README.adoc b/README.adoc deleted file mode 100644 index e0683ff..0000000 --- a/README.adoc +++ /dev/null @@ -1,155 +0,0 @@ -image:https://travis-ci.org/mhinz/vim-startify.svg?branch=travis["Build Status", link="https://travis-ci.org/mhinz/vim-startify"] - -image:https://raw.githubusercontent.com/mhinz/vim-startify/102aa438b2d2a88e2b4e331d8ff5320eed52f0c4/startify.png[Startify in action!] - -That's it. A fancy start screen for Vim. _(almost all visible features enabled - freely customizable)_ - ---- - -* <> - . <> - . <> - . <> -* <> -* <> -* <> - ---- - -== What does it provide? - -It does 3 things that will be explained in detail further below: - -=== It shows things on start! - -If you start Vim without giving any filenames or piping text to it, Startify -will show a pretty start screen that shows a configurable list of files or -directories: - -- *Custom header*: How about some ASCII art action? - Perhaps even dynamically generated? - * _Default:_ `` - -- *Recently used files from directory*: List recently modified files - from the current directory recursively. The list can also be filtered. - * _Default:_ `` - -- *Recently used files*: List recently used files. The - list can also be filtered. - * _Default:_ `` - -- *Sessions*: List all your sessions from a certain - directory. - * _Default:_ `~/.vim/session` - -- *Bookmarks*: Define bookmarks, thus entries for files that will always be - listed. - * _Default:_ `` - -- *Custom footer*: Same as the custom header.. but at the - bottom. - * _Default:_ `` - -TIP: See `:h startify-options` for more information. - -==== Powerful menu handling - -You can either navigate the menu by using the usual suspects (`j`, `G`, `}` -etc.) and hit `` or just key in whatever is written between the square -brackets on that line. You can even double-click anywhere on the line. - -Moreover, you can open several files at one go! Navigate to an entry and hit -either `b` (open in same window), `s` (open in split), `v` (open in vertical -split) or `t` (open in tab) for marking it. You can mark several entries and -also mix different markers. Afterwards execute all the markers in the order -they were given via ``. - -In case you don't want to open a file, there is also `e` for creating an empty -buffer, `i` for creating an empty buffer and jumping into insert mode and `q` -for quitting. - -When one or more files were opened by Startify, it will close automatically. -You can always reopen the screen via `:Startify`. - -==== Easy session handling - -TIP: Please read and understand `:help 'sessionoptions'` if you work with -sessions. - -Essentially there are two supported workflows for handling sessions that will -be shown here: - -*The Startify way:* - -The handling of loading, saving and deleting sessions is eased by always -working with one and the same directory. These commands are used for -convenience: - - :SLoad load a session - :SSave save a session - :SDelete delete a session - -TIP: See `:h startify-commands` for more information. - -The advantage of always using the same directory is that Startify can -conveniently show you a list of all your sessions. - -*The old way:* - -The old way means using `:mksession` to save a `Session.vim` file to the -current directory. Imagine a project folder with a Session.vim at its root -directory. This way makes it very portable. - -When Vim gets started and the file Session.vim is found in the current -directory, it will be shown at the top of all lists as entry `[0]` as a -shortcut. - -If you bookmark a directory (project folder, anyone?) that contains a -Session.vim, and you access that directory via Startify, that session will be -loaded automatically. - -*Optionally:* - -There is even support for *persistent sessions*. Thus you load a session via -Startify, add some buffers, remove some buffers, change the window layout, .. -and when you finish and exit Vim, the session will be saved automatically. This -works for both ways of handling sessions. - -TIP: Read `:help startify-options` to learn more about how to configure session -handling to your liking. - -My own configuration can be found -https://github.com/mhinz/dotfiles/blob/7e1989e902e5d9d25af5e15c2064f47a33e9d86b/vim/vimrc#L612-L642[here]. - -== Installation and Documentation - -Use your favorite plugin manager. - -Using https://github.com/junegunn/vim-plug[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 - -== 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. - -*Names:* Marco Hinz, mhinz, mhi^, mhi - -*Mail:* `` - -*Twitter:* https://twitter.com/\_mhinz_[@\_mhinz_] - -*Stackoverflow:* http://stackoverflow.com/users/1606959/mhinz[mhinz] - -_Thank you for flying mhi airlines. Get your Vim on!_ - -== License - -MIT license. Copyright (c) 2015 Marco Hinz. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb385d0 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +![vim-startify](https://raw.githubusercontent.com/mhinz/vim-startify/master/pictures/startify-logo.png) + +[![Build Status](https://travis-ci.org/mhinz/vim-startify.svg?branch=master)](https://travis-ci.org/mhinz/vim-startify) +[![Join the chat at https://gitter.im/mhinz/mhinz](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mhinz/mhinz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](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 + +![Startify in action!](https://github.com/mhinz/vim-startify/blob/master/pictures/startify-menu.png) +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!_ diff --git a/pictures/startify-logo.png b/pictures/startify-logo.png new file mode 100644 index 0000000..ce02396 Binary files /dev/null and b/pictures/startify-logo.png differ diff --git a/startify.png b/pictures/startify-menu.png similarity index 100% rename from startify.png rename to pictures/startify-menu.png