Marco Hinz 12 лет назад
Родитель
Сommit
b97e3c71d0
1 измененных файлов с 66 добавлено и 17 удалено
  1. 66 17
      README.md

+ 66 - 17
README.md

@@ -5,10 +5,17 @@ This is it. A start screen for Vim.
 What does it provide?
 What does it provide?
 ---------------------
 ---------------------
 
 
+It does 3 things that will be explained in detail further below:
+
+* it shows lists of files and directories
+* eased session handling
+* powerful menu entry handling
+
 #### 1) It shows things on start!
 #### 1) It shows things on start!
 
 
 If you start Vim without giving any filenames or piping text to it, Startify
 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:
+will show a pretty start screen that shows a configurable list of files or
+directories:
 
 
 ---
 ---
 
 
@@ -48,19 +55,55 @@ See `:h startify-options` for more information.
 
 
 #### 2) Easy session handling
 #### 2) Easy session handling
 
 
-When the file Session.vim is found in the current directory, it will be shown at
-the top of all lists as entry `[0]`.
+_Please read and understand `:help 'sessionoptions'` if you work with sessions._
 
 
-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:
+Essentially there are two kinds of supported workflows for handling sessions
+that will be shown here.
+
+---
+
+__a)__ 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
     :SLoad    load a session
     :SSave    save a session
     :SSave    save a session
     :SDelete  delete a session
     :SDelete  delete a session
 
 
-See `:h startify-commands` for more information.
+_See `:h startify-commands` for more information._
+
+The advantage of always using the same directory is that Startify can show you a
+list of all your sessions that are scattered around the system.
+
+---
+
+__b)__ 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.
 
 
-#### 3) Easy but powerful entry handling
+_Read `:help startify-options` to learn more about how to configure session
+handling to your liking._
+
+#### 3) Powerful entry handling
 
 
 You can either navigate to a certain entry using `j`/`k` and hit `<cr>` or just
 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
 key in whatever is written between the square brackets on that line. You can
@@ -79,15 +122,25 @@ for quitting.
 When one or more files were opened by Startify, it will close automatically. You
 When one or more files were opened by Startify, it will close automatically. You
 can always reopen the screen via `:Startify`.
 can always reopen the screen via `:Startify`.
 
 
-Feedback, please!
+Author & Feedback
 -----------------
 -----------------
 
 
-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.
+If you like any of my plugins, please star it on github. That is a great way of
+getting feedback. Same for issues reports or feature requests.
 
 
-Thank you for flying mhi airlines. Get your Vim on!
+---
+
+Marco Hinz _aka_ mhinz _aka_ mhi^ _aka_ mhi
+
+Mail: `<mh.codebro@gmail.com>`
 
 
-You can also follow me on Twitter: [@_mhinz_](https://twitter.com/_mhinz_)
+Twitter: [@_mhinz_](https://twitter.com/_mhinz_)
+
+Stackoverflow: [mhinz](http://stackoverflow.com/users/1606959/mhinz)
+
+---
+
+Thank you for flying mhi airlines. Get your Vim on!
 
 
 Installation & Documentation
 Installation & Documentation
 ----------------------------
 ----------------------------
@@ -104,11 +157,7 @@ documentation for further customization:
 
 
     :Helptags  " rebuilding tags files
     :Helptags  " rebuilding tags files
     :h startify
     :h startify
-
-Author
-------
-
-Marco Hinz `<mh.codebro@gmail.com>`
+    :h startify-faq
 
 
 License
 License
 -------
 -------