Write the README

This commit is contained in:
Elmar Hinz 2014-09-25 06:42:28 +02:00
parent 9df098bf5f
commit d0ba1eafe4

View file

@ -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.