Skip to content

Commit

Permalink
readme: added readme for rust and mini fix for python
Browse files Browse the repository at this point in the history
  • Loading branch information
danielratiu committed Jul 29, 2024
1 parent 1375d79 commit 7511483
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
3 changes: 2 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ This repository contains tooling for reading MPS models from command line - with
### Projects
- A Gradle plugin for reading MPS files and building an object model - [here](mps-cli-gradle-plugin/Readme.md).
- A Python library for reading MPS files and building an object model - [here](mps-cli-py/Readme.md).
- A Typescript libeary for reading MPS files and building an object model - [here](mps-cli-ts/Readme.md).
- A Typescript library for reading MPS files and building an object model - [here](mps-cli-ts/Readme.md).
- A Rust library for reading MPS files and building an object model - [here](mps-cli-rs/Readme.md).

### Repository Structure
- `mps-cli-gradle-plugin` - the gradle plugin to read MPS models
Expand Down
2 changes: 1 addition & 1 deletion mps-cli-py/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The core of the Python object model is given by the following classes:
- `SRepository` - the repository containing the parsed model and meta-information

### Limitations
The plugin has currently the following limitations:
The library has currently the following limitations:
- the recovered language information reflects only the used language in the loaded solutions

### Run tests
Expand Down
25 changes: 25 additions & 0 deletions mps-cli-rs/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## MPS CLI Rust Library

This project provides a Rust library which parses MPS files and builds the object model.

### Features
The following features are available:
- load MPS files (*.mpsr, *.mps, *.jar) and expose their content as Rust object model
- solutions, models, root nodes, nodes, children, references, properties
- extract the meta-information and expose it as Rust object model
- list of languages, their concepts with information about properties, references, children

The core of the Rust object model is given by the following structures
- `SNode` - represents a node
- `SModel` - represents a model
- `SSolution` - represents a solution
- `SRepository` - the repository containing the parsed model and meta-information

### Limitations
The library has currently the following limitations:
- the recovered language information reflects only the used language in the loaded solutions

### Run tests

- `cd mps-cli-rs`
- `cargo test`

0 comments on commit 7511483

Please sign in to comment.