#####
##### Attention
#####
This is a fork of https://bitbucket.org/shor-ty/vimextensionopenfoam/overview by Tobias Holzmann
with the aim of reaching Pathogene/Vundle compatibility aswell as Colorscheme neutrality.
Right now Pathogene/Vundle compatibility works but the changes break autocomplete-compatibility
for non-vundle/pathogene installs.
The colorscheme is still available but by default vim will use YOUR colorscheme and not the supplied one.

Installation with vundle (https://github.com/gmarik/Vundle.vim) is as easy as adding it to your .vimrc
with
"Plugin effi/vim-OpenFoam-syntax"
or
"Plugin git://bitbucket.org/effi-x/vim-openfoam-syntax.git"
It is highly recommended to use the great solarized theme/colorscheme by ethan schoonover at
http://ethanschoonover.com/solarized


# Welcome #

This short intruduction includes the steps which are necessary to get this application up and running.

### OpenFOAM Versions ###
* Generated for all versions

### What is this repository for? ###
* This extension to the vim editor allows you to highlight a lot of OpenFOAM keywords
* Version 2.1
* Developed by [Holzmann-cfd](https://holzmann-cfd.de)

### How do I get set up? ###
* Feel free to compile it where ever you want, but normally its nice to have a fixed folder for _user compiled stuff_
* Make a new folder
> mkdir -p $FOAM_RUN/../OpenFOAM_extensions
* Switch to the new folder
> cd $FOAM_RUN/../OpenFOAM_extensions
* Clone the repository to the new folder
> git clone https://[email protected]/shor-ty/vimExtensionOpenFOAM.git
* Switch to the repository directory
> cd vimExtensionOpenFOAM
* Install the extension by using the _install_ script
> ./install
* Finished

### Change color and keywords ###
* If you have questions, hints or any suggestions please email me
* If you want to change the colors you can change the following file
> ./vim/color/*.vim
* Additionally you can copy paste one file and make your own colorscheme. To use it change it in
> ./vim/scripts.vim
* If you insert more keywords you can make a new branch or merge to the master

### Version Changes ###
#### Version 2.1 ####
* Split the openfoam.vim file into foam tree in syntax/openfoam/*
* Added check into install script to check if there is already the entrys available in $HOME/.vimrc

#### Version 2.0 ####
* Added new keywords

### Thanksgiving ###
* Karl-Johan Nogenmyr