README.md 2.09 KB
Newer Older
1
![SSG](media/ssg.png)
2
# Simple State Generator
Adrian Wuillemet's avatar
Adrian Wuillemet committed
3

4
Projekt zur Erzeugung von Code aus Fine State Machines.
Rico Possienka's avatar
Rico Possienka committed
5

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
**Autoren**: Jakob Baatz, Pavel Nepke, Rico Possienka, Marco Wenning, Adrian Wuillemet

<br/>  

## Userguide to Testing the tool

### 1. Requirements
The following requirements need to be installed on your system:

    + Python 3.x.x
    + Chrome or Chromium
    
If you do not have those installed you can download them here: [Python](https://www.python.org/downloads/) & [Chromium](https://chromium.woolyss.com)  

<br/>  

### 2. Setup
Adrian Wuillemet's avatar
Adrian Wuillemet committed
23
To get the program up and running open a bash terminal _(such as git bash)_ and follow the steps below:
24
25
26
27
28
29

First: Make sure you have the proper version of Python installed:
```shell
$ python --version
Python 3.7.3
```
Adrian Wuillemet's avatar
Adrian Wuillemet committed
30
Running the command should print something like the python version in the example. If a version of 2.x.x is printed try:
31
32
33
34
35
36
37
38
39
40
```shell
$ python3 --version
```
Second: To make life easier we recommend creating a temporary alias by doing the following:
```shell
$ alias ssg="python main.py"

#or if both versions are available
$ alias ssg="python3 main.py"
```
Adrian Wuillemet's avatar
Adrian Wuillemet committed
41
42
Then checkout the source code and navigate to the source/package directory.  
If you do not mind installing python libraries globally on your system skip the first two commands:
43
44
45
46
```shell
# create a virtual environment for testing

$ python3 -m venv .
Adrian Wuillemet's avatar
Adrian Wuillemet committed
47
$ source bin/activate
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# install all python dependencies [this may take several seconds]

$ pip3 install click eel python-interface

# checkout the source code and navigate to the right folder

$ git clone https://gitlab.beuth-hochschule.de/s40242/stategen.git
$ cd stategen/source/package
```
Now you can start testing the tool!  

<br/>  

### 3. Running commands
You can now test the tool by running the following commands from the commandline:
```shell
# with alias ssg in place, other substitute ss with python3 main.py

$ ssg --help

# from here on you can navigate with all information provided by the help function. 
# For convenience here are some things to try out:
Adrian Wuillemet's avatar
Adrian Wuillemet committed
71
$ ssg --version
72
73
74
75

$ ssg languages

$ ssg parse somefile.txt --language javascript -v
Adrian Wuillemet's avatar
Adrian Wuillemet committed
76

77
78
$ ssg gui
```