From 751148337156ae2c3f1eb5873963d4d2f83d2c6f Mon Sep 17 00:00:00 2001 From: danielratiu Date: Mon, 29 Jul 2024 22:01:17 +0200 Subject: [PATCH] readme: added readme for rust and mini fix for python --- Readme.md | 3 ++- mps-cli-py/Readme.md | 2 +- mps-cli-rs/Readme.md | 25 +++++++++++++++++++++++++ 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 mps-cli-rs/Readme.md diff --git a/Readme.md b/Readme.md index 53ced36..eb3e876 100644 --- a/Readme.md +++ b/Readme.md @@ -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 diff --git a/mps-cli-py/Readme.md b/mps-cli-py/Readme.md index 41d1072..cccd6a4 100644 --- a/mps-cli-py/Readme.md +++ b/mps-cli-py/Readme.md @@ -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 diff --git a/mps-cli-rs/Readme.md b/mps-cli-rs/Readme.md new file mode 100644 index 0000000..0788f41 --- /dev/null +++ b/mps-cli-rs/Readme.md @@ -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`