Skip to content

Commit

Permalink
Updated README file
Browse files Browse the repository at this point in the history
Added installation process
Added explanation on how to run tests, parse and highlight a file
Added current status
  • Loading branch information
osman362 committed Nov 3, 2023
1 parent 643c481 commit c1cacdd
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# tree-sitter-modelica

An [open-source](OSMC-License.txt) Modelica ([Modelica Language Specification v3.5](https://specification.modelica.org/maint/3.5/MLS.html)) grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter).
An [open-source](OSMC-License.txt) Modelica ([Modelica Language Specification v3.5](https://specification.modelica.org/maint/3.5/MLS.html)) grammar and highlighting-query for [tree-sitter](https://github.com/tree-sitter/tree-sitter).

Currently used by [OMFrontend.js](https://github.com/OpenModelica/OMFrontend.js).
## Installation

```bash
npm install
npm run build
```

To generate the C code to parse Modelica, run:

```bash
npx tree-sitter generate
# Skip npx if you have ./node_modules/.bin in your PATH
# tree-sitter generate
```

## Unit Tests

There is a number of tests included. To run all tests defined in [test/](./test/), just run:

```bash
npx tree-sitter test
```

### Examples

To test the parser on a Modelica file, you can run:

```bash
npx tree-sitter parse examples/SimpleMath.mo
```

## Highlighting

There is also a highlighting query included. To test the highlighting you can run:

```bash
npx tree-sitter highlight examples/SimpleMath.mo
```

## Current Status

Tree-sitter-modelica has been tested on a "Save Total" version of the DrumBoiler.mo file which was successfully parsed and highlighted.

0 comments on commit c1cacdd

Please # to comment.