Commit 44a34443 authored by Philip Makedonski's avatar Philip Makedonski
Browse files

+ added readme

parent 2a2d17a9

README.md

0 → 100644
+44 −0
Original line number Diff line number Diff line 
# T3Tools



## Setup



TODO: Migrate and update



## Usage



TODO: Migrate and update



## Development



To get started and make sure everything is set up and running:

    * download and setup Java 21 (if missing): []([https://adoptium.net/en-GB/marketplace/)

    * download and setup Eclipse Java and DSL Package: [](https://www.eclipse.org/downloads/packages/release/2024-09/r/eclipse-ide-java-and-dsl-developers)

    * clone t3q repo: https://gitlab.gwdg.de/swe/tools/t3tools/t3q

    * start Eclipse and click on “Import projects…” in the “Project Explorer” (or via File -> Import in the menu)

        * select “General” -> “Existing Projects into Workspace”

        * press “Browse…” next to “Select root directory” and open the folder where the git repo was cloned

        * press “Finish” with all projects selected

        * run the “GenerateTTCN3.mwe2” script to generate the missing resources

            * open `de.ugoe.cs.swe.TTCN3/src/de/ugoe/cs/swe/GenerateTTCN3.mwe2`

            * right click -> “Run as” -> “MWE2 Workflow”

            * an automated build should start after the script is finished

        * run “T3Q” to make sure everything works

            * “Run” -> “Run configurations...” from the menu

            * select “Java Application” -> “T3Q”

            * press “Run”

            * you should get an Error in the console that no input was provided

    * clone t3q-resources repo: [](https://gitlab.gwdg.de/swe/tools/t3tools/t3q-resources)

    * run “T3Q” with the input location

        * same as above, but select the “T3Q (sample)” launch configuration

        * before pressing “Run”, select the “Arguments” tab and append the path to where the t3q-resources repo was cloned

        * press “Apply” to save, subsequent launching of “T3Q (sample)” will use this path

        * press “Run”



To extend the usage analyzer:

    * run “T3Q” with the usage analysis option

        * open the “T3Q (sample)” launch configuration (or duplicate in a new one)

        * in the “Arguments tab add “--analyze-usage” to the program arguments

        * press “Apply” and “Run”

    * extend and adapt the “UsageAnalyzer” class in a new branch

        * see the example analyses with loops and streams, immediate output and collected/synchronised output

        * Push the changes to the branch regularly 
 No newline at end of file