Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackyko1991 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
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.

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)
[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 `<sublime text install path>/Packages`
5. Open any OpenFOAM dictionary file with Sublime Text and set the highlighting with `View` -> `Syntax` -> `OpenFOAMDictionary`