From 5e5c6252fa4e333d270586ecdbe33412586ab1ce Mon Sep 17 00:00:00 2001 From: danielratiu Date: Fri, 31 Jan 2020 23:25:00 +0100 Subject: [PATCH] documentation improvements --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7ab03cd6..accd2234 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ -# mps-qa -Repository Containing Quality Assurance Tooling for Jetbrains' MPS +# MPS-QA +Repository Containing Quality Assurance Tooling for Jetbrains' MPS. We have the following components: -* clone detection on models +* clone detection on models (ready to use) +* automated synthesis of models given a set of DSLs (early development phase) + +## Clones Detection +#### Motivation +When models (both on language development and use sides) are developed over several years, people tend to copy/paste and adapt existing code. This leads to redundancies and hard to maintain code. Furthermore, there are situations when copy-paste is the only way to reuse some code, and this can reveal lack of adequate abstractions which would enable reuse. + +#### Using the Clones Detection +There are two possibilities to use the clones detection: +* you can either download the released plugins from the release page +** please make sure to download plugins which match your MPS version! +* you can build the clones detection MPS plugins from sources + +**Building the mps.qa.clones plugin** +1. rename "gradle.properties.example" in "gradle.properties" +2. set the required macros (mpsqa.home and mpsHomeDir) +3. open a terminal and call `gradlew.bat`