update docs; add screenshot
This commit is contained in:
parent
34ec263a17
commit
1129f480ea
49
README.md
49
README.md
|
@ -1,10 +1,51 @@
|
|||
_NOTE_: This plugin is still in development
|
||||
|
||||
vim-startify
|
||||
------------
|
||||
|
||||
If Vim is called without filenames, vim-startify will bring up a "start screen"
|
||||
which shows recently used files and also sessions.
|
||||
Startify basically provides two things:
|
||||
|
||||
1) If you start Vim without giving any filenames to it (or pipe stuff to it so
|
||||
it reads from STDIN), startify will show a small but pretty start screen
|
||||
which shows recently used files and sessions by default.
|
||||
|
||||
2) It eases handling of loading and saving sessions by only working with a
|
||||
certain directory. Two commands are used for convenience:
|
||||
|
||||
:SLoad load a session
|
||||
:SSave save a session
|
||||
|
||||
The default settings are pretty sane, so it should work without any
|
||||
configuration.
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||
Afterwards installing Sy is as easy as pie:
|
||||
|
||||
2. git clone https://github.com/mhinz/vim-startify ~/.vim/bundle/vim-startify
|
||||
2. start Vim
|
||||
2. :Helptags
|
||||
2. :h startify
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
`:h startify`
|
||||
|
||||
Author
|
||||
------
|
||||
|
|
|
@ -46,7 +46,8 @@ Startify basically provides two things:
|
|||
:SLoad load a session
|
||||
:SSave save a session
|
||||
|
||||
The default settings are pretty sane, so it should work without configuration.
|
||||
The default settings are pretty sane, so it should work without any
|
||||
configuration.
|
||||
|
||||
|
||||
==============================================================================
|
||||
|
|
BIN
startify.png
Normal file
BIN
startify.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
Loading…
Reference in a new issue