diff options
| -rw-r--r-- | modelica-parser-lalrpop/Cargo.toml | 1 | ||||
| -rw-r--r-- | modelica-parser-lalrpop/README.md | 18 |
2 files changed, 19 insertions, 0 deletions
diff --git a/modelica-parser-lalrpop/Cargo.toml b/modelica-parser-lalrpop/Cargo.toml index fabffe5..6371bbf 100644 --- a/modelica-parser-lalrpop/Cargo.toml +++ b/modelica-parser-lalrpop/Cargo.toml @@ -9,6 +9,7 @@ rust parser crate. keywords = ["modelica", "lalrpop", "parser"] build = "src/build.rs" # LALRPOP preprocessing license = "MIT" +readme = "README.md" [lib] name = "modelica_parser" diff --git a/modelica-parser-lalrpop/README.md b/modelica-parser-lalrpop/README.md new file mode 100644 index 0000000..f5a52b2 --- /dev/null +++ b/modelica-parser-lalrpop/README.md @@ -0,0 +1,18 @@ +modelica-parser-lalrpop +============================ + +This is a pure-Rust library for parsing a subset of the Modelica modeling +language, built with the lalrpop parsing library. + +The current implementation was not written to be complete or closely follow the +lexing/parsing definitions from the formal Modelica standard. Instead it has +been cobbled together piecemeal with the goal of parsing a reasonable fraction +of real-world existing models. Given this, the parser is incorrect in a number +of corner cases, and it probably does not make sense to correct those +one-by-one. + +Contributions or a re-write to be more correct or more complete are welcome! + +To try parsing a set of example files: + + cargo run --example parse_file examples/modelica_models/*.mo |