vim-sussify/README.md

69 lines
1.9 KiB
Markdown
Raw Normal View History

2013-04-23 16:41:02 +02:00
vim-startify
------------
2013-04-24 08:01:07 +02:00
Startify basically provides two things:
2013-04-24 08:09:19 +02:00
_1)_ If you start Vim without giving any filenames to it (or pipe stuff to it so
2013-04-24 08:01:07 +02:00
it reads from STDIN), startify will show a small but pretty start screen
2013-04-24 12:15:16 +02:00
which shows recently used files (using viminfo) and sessions by default.
2013-04-24 08:01:07 +02:00
2013-04-24 10:42:35 +02:00
Additionally, you can define bookmarks, thus entries for files that always
should be available in the start screen.
2013-04-24 08:06:47 +02:00
You can either navigate to a certain menu entry or you just key in whatever
is written between the square brackets on that line.
2013-04-24 08:09:19 +02:00
_2)_ It eases handling of loading and saving sessions by only working with a
2013-04-24 08:01:07 +02:00
certain directory. Two commands are used for convenience:
:SLoad load a session
:SSave save a session
2013-04-24 15:07:30 +02:00
NOTE: Both commands can also take session names directly as an argument. You can
also make use of completion via `<c-u>` and `<tab>`.
2013-04-24 08:01:07 +02:00
The default settings are pretty sane, so it should work without any
configuration.
![Example:startify in action](https://github.com/mhinz/vim-startify/raw/master/startify.png)
Feedback, please!
-----------------
If you like any of my plugins, star it on github. This is a great way of getting
feedback! Same for issues or feature requests.
Thank you for flying mhi airlines. Get the Vim on!
Installation
------------
If you have no preferred installation method, I suggest using tpope's pathogen:
1. git clone https://github.com/tpope/vim-pathogen ~/.vim/bundle/vim-pathogen
1. mkdir -p ~/.vim/autoload && cd ~/.vim/autoload
1. ln -s ../bundle/vim-pathogen/autoload/pathogen.vim
2013-04-24 11:52:32 +01:00
Afterwards installing vim-startify is as easy as pie:
2013-04-24 08:01:07 +02:00
2. git clone https://github.com/mhinz/vim-startify ~/.vim/bundle/vim-startify
2. start Vim
2. :Helptags
2. :h startify
Documentation
-------------
`:h startify`
2013-04-23 16:41:02 +02:00
Author
------
Marco Hinz `<mh.codebro@gmail.com>`
License
-------
Copyright © Marco Hinz. Distributed under the same terms as Vim itself. See
`:help license`.