From d0ba1eafe406984df9ac4de7e6bee445bf44cb5b Mon Sep 17 00:00:00 2001 From: Elmar Hinz Date: Thu, 25 Sep 2014 06:42:28 +0200 Subject: [PATCH] Write the README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 127b628..4a9e581 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,45 @@ vim.typoscript ============== Syntax highlighting for the unbeatable vim text editor + +Installation +============ + +Bundle Installation +------------------- + +* Patogen: clone into your *.vim/bundle/* directory +* Vundle: not tested yet +* Neobundle: not tested yet + +Oldfashioned +------------ + +Put the files into the appropriate directories. Not testes yet. + +Your Experiance +--------------- + +Please report, if you sucessfully used one of the untested installation methodes. +Even better, clone the repo, update this file, add others as needed, send a pull request. + +What makes it unique? +===================== + +Comparism to other vim syntax highlighting for TypoScript: + + * Others: Exessive use of Keywords to detect the higlighted items. + * This: Syntax analyses by regular experessions to detec the items. + + Future improvement: Merge best of both worlds. + +Motivation +========== + +I have done this, to learn VimScript and vim bundle building. + +License +======= + +MIT License. See the LICENSE file. +