README: refactoring
This commit is contained in:
Marco Hinz
parent
98aaf4e70c
commit
e7ce96c243
116
README.md
116
README.md
|
|
@ -1,44 +1,80 @@
|
|||
|
||||
|
||||
This is it. A splash screen for Vim.
|
||||
This is it. A start screen for Vim.
|
||||
|
||||
What does it provide?
|
||||
---------------------
|
||||
|
||||
__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
|
||||
that shows recently used files (using viminfo) and sessions by default.
|
||||
#### 1) It shows things on start!
|
||||
|
||||
Additionally, you can define bookmarks, thus entries for files that always
|
||||
should be available on the start screen.
|
||||
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 items:
|
||||
|
||||
You can either navigate to a certain menu entry and hit enter or you just
|
||||
key in whatever is written between the square brackets on that line. You
|
||||
can even double-click anywhere on the line now.
|
||||
---
|
||||
|
||||
In addition, `e` creates an empty buffer, `i` creates an empty buffer and
|
||||
jumps into insert mode, `q` quits.
|
||||
__Custom header__ ( _empty by default_ ):
|
||||
|
||||
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) or `v` (open in
|
||||
vertical split). You can do that for multiple entries. You can also mix
|
||||
them. The order of the selections will be remembered. Afterwards execute
|
||||
these actions via `<cr>`.
|
||||
How about some ASCII art action?
|
||||
|
||||
When the selection is finished, Startify will close automatically. You can
|
||||
reopen the screen via `:Startify`.
|
||||
---
|
||||
|
||||
And you can define your own custom ascii art header now!
|
||||
__Files from directory__ ( _disabled by default_ ):
|
||||
|
||||
__2)__ It eases handling of loading and saving sessions by only working with a
|
||||
certain directory. These commands are used for convenience:
|
||||
This lists all files from the current directory sorted by modification time.
|
||||
|
||||
:SLoad load a session
|
||||
:SSave save a session
|
||||
:SDelete delete a session
|
||||
---
|
||||
|
||||
__NOTE__: These commands can also take session names directly as an argument.
|
||||
You can also make use of completion via `<c-d>` and `<tab>`.
|
||||
__Recently used files__ ( _enabled by default_ ):
|
||||
|
||||
This uses the viminfo file to get a list of most recently used files. The list
|
||||
can also be filtered.
|
||||
|
||||
---
|
||||
|
||||
__Sessions__ ( _enabled by default_ ):
|
||||
|
||||
This will list all your sessions from a certain directory.
|
||||
|
||||
---
|
||||
|
||||
__Bookmarks__ ( _empty by default_ ):
|
||||
|
||||
Additionally, you can define bookmarks, thus entries for files that always
|
||||
should be available on the start screen.
|
||||
|
||||
---
|
||||
|
||||
See `:h startify-options` for more information.
|
||||
|
||||
#### 2) Easy session handling
|
||||
|
||||
It eases handling of loading, saving and deleting sessions 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
|
||||
|
||||
See `:h startify-commands` for more information.
|
||||
|
||||
#### 3) Easy but powerful entry handling
|
||||
|
||||
You can either navigate to a certain entry using `j`/`k` and hit `<cr>` 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) or `v` (open in vertical
|
||||
split) 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
|
||||
`<cr>`.
|
||||
|
||||
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`.
|
||||
|
||||
Feedback, please!
|
||||
-----------------
|
||||
|
|
@ -46,31 +82,23 @@ 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!
|
||||
Thank you for flying mhi airlines. Get your Vim on!
|
||||
|
||||
Installation
|
||||
------------
|
||||
Installation & Documentation
|
||||
----------------------------
|
||||
|
||||
If you have no preferred installation method, I suggest using tpope's pathogen:
|
||||
|
||||
$ git clone https://github.com/tpope/vim-pathogen ~/.vim/bundle/vim-pathogen
|
||||
$ mkdir -p ~/.vim/autoload && cd ~/.vim/autoload
|
||||
$ ln -s ../bundle/vim-pathogen/autoload/pathogen.vim
|
||||
|
||||
Afterwards installing vim-startify is as easy as pie:
|
||||
If you have no preferred installation method, I suggest using tpope's
|
||||
[pathogen](https://github.com/tpope/vim-pathogen). Afterwards installing
|
||||
vim-startify is as easy as pie:
|
||||
|
||||
$ git clone https://github.com/mhinz/vim-startify ~/.vim/bundle/vim-startify
|
||||
$ start Vim
|
||||
$ :Helptags
|
||||
$ :h startify
|
||||
$ vim
|
||||
|
||||
It works without any configuration, but you might want to look into the
|
||||
documentation for further customization.
|
||||
documentation for further customization:
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
`:h startify`
|
||||
:Helptags " rebuilding tags files
|
||||
:h startify
|
||||
|
||||
Author
|
||||
------
|
||||
|
|
|
|||
Loading…
Reference in a new issue