adding.md

Add relast2uml to your project

If you want to use Relast2Uml, either use the latest pre-build version or clone the repository and build it yourself.

Use packaged version

Check the package overview page to find the latest versions of the individual packages.

First add this GitLab as a repository in your build.gradle:

repositories {
    maven {
        name "gitlab-maven"
        url "https://git-st.inf.tu-dresden.de/api/v4/groups/jastadd/-/packages/maven"
    }
}

grammar2uml

To use Grammar2uml, add it as a dependency:

configurations {
    grammar2umlClasspath
}

dependencies {
    grammar2umlClasspath group: 'de.tudresden.inf.st', name: 'grammar2uml', version: '0.1.1'
}

Finally, add a task to create your visualization:

task grammar2uml(type: JavaExec) {
    main = 'de.tudresden.inf.st.jastadd.grammar2uml.compiler.Compiler'
    classpath = configurations.grammar2umlClasspath

    args([
            '--verbose',
            'src/main/jastadd/GoalModel.relast'
    ])
}

dumpAst

To use DumpAst, add it as a dependency:

dependencies {
    implementation group: 'de.tudresden.inf.st', name: 'dumpAst', version: '0.3.7'
}

Build from source

If you want to build the tools of Relast2Uml from source, first build the jar from the Relast2Uml repository:

git clone https://git-st.inf.tu-dresden.de/jastadd/relast2uml.git
cd relast2uml
./gradlew jar
ls dumpAst/build/libs/

Those JARs can then be copied to your project.

cp dumpAst/build/libs/dumpAst-<version>.jar ../your-project/libs/dumpAst.jar
cd ../your-project/

Finally, this JAR has to be integrated into your build process. In case Gradle is used, the JAR file needs to be added as dependency using:

dependencies {
    implementation fileTree(include: ['dumpAst.jar'], dir: 'libs')
}

The path to the JAR file may need to be changed according to your project structure.