diff --git a/README.md b/README.md index d2309b2..b199533 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -OpenFOAM dictionary syntax highlighing for Sublime Text -======= +# OpenFOAM dictionary syntax highlighing for Sublime Text -About -===== +# About This is a work in progress. Contributions are welcome. @@ -10,4 +8,11 @@ The goal is to build a simple syntax highlighting definition for OpenFOAM dictionary files to make navigation and editing a little easier. Editing is done to the YAML file and translated using -[SerializedDataConverter](https://github.com/facelessuser/SerializedDataConverter) \ No newline at end of file +[SerializedDataConverter](https://github.com/facelessuser/SerializedDataConverter) + +## Installation +1. Download the repository to any place of your computer +2. Zip the downloaded repository folder with name `OpenFOAMDictionary.zip` +3. Rename the suffix of `.zip` to `.sublime-package` +4. Move the `OpenFOAMDictionary.sublime-package` to `/Packages` +5. Open any OpenFOAM dictionary file with Sublime Text and set the highlighting with `View` -> `Syntax` -> `OpenFOAMDictionary`