Skip to content

Commit

Permalink
README.md: update information about subprojects
Browse files Browse the repository at this point in the history
  • Loading branch information
sergej-koscejev authored Jun 12, 2024
1 parent c589295 commit 09f8f72
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,32 @@ This project contains the following subprojects:

* `project-loader` – a library for command-line utilities providing a function to load MPS with specified plugins and
macros, and execute code in the context of a running MPS instance, optionally with a particular project open.
* `execute` - a command line tool to execute a piece of code from an MPS module with a particular project open.
* `execute-generators` – a command line tool to execute the MPS generator on given models.
* `launcher` - a Gradle plugin for configuring the Java toolchain and command line arguments for a particular version
of MPS.
* `modelcheck` – a command line tool to check given models or modules for errors.
* `integration-tests` – tests that exercise `execute-generators` and `modelcheck` on sample projects.
* `remigrate` - a command line tool to run re-runnable migrations on a project (or multiple projects).
* `integration-tests` – tests that exercise the command line tools on sample projects.

The command-line tools are documented in their respective README.md files:
The subprojects are documented in their respective README.md files:

* [`execute`](execute/README.md)
* [`execute-generators`](execute-generators/README.md)
* [`launcher`](launcher/README.md)
* [`modelcheck`](modelcheck/README.md)
* [`remigrate`](remigrate/README.md)

## Relationship to `mbeddr/mps-gradle-plugin`

This project was extracted from [`mbeddr/mps-gradle-plugin`](https://github.com/mbeddr/mps-gradle-plugin) using
[`git-filter-repo`](https://github.com/newren/git-filter-repo) to keep Git commit history.
This project was originally extracted from [`mbeddr/mps-gradle-plugin`](https://github.com/mbeddr/mps-gradle-plugin)
using [`git-filter-repo`](https://github.com/newren/git-filter-repo) to keep Git commit history.

The new project will use a different versioning scheme. The original project published separate versions for each MPS
major release (20xx.y). This project will strive to support multiple MPS versions from one code base and will use
semantic versioning instead.
## Versioning

This project strives to support multiple MPS versions from one code base and uses semantic versioning.

## Supported MPS versions

The current version supports MPS 2021.3 to MPS 2022.3. It may work with earlier or later MPS versions but is not tested
with them.
See `SUPPORTED_MPS_VERSIONS` in the [integration tests](integration-tests/build.gradle.kts#L24) for a list of supported
MPS versions.

0 comments on commit 09f8f72

Please sign in to comment.