Commit fe6acf30 authored by Adrian Wuillemet's avatar Adrian Wuillemet
Browse files

Correct Top Level Readme

parent 2998cb53
![SSG](media/ssg.png)
# Simple State Generator
![Beads](https://gitlab.beuth-hochschule.de/s40242/stategen/raw/master/source/beads/resources/ui/media/logo.png)
# Beads<sup>&copy;</sup>
Projekt zur Erzeugung von Code aus Fine State Machines.
**Autoren**: Jakob Baatz, Pavel Nepke, Rico Possienka, Marco Wenning, Adrian Wuillemet
<br/>
<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
To get the program up and running open a bash terminal _(such as git bash)_ and follow the steps below:
First: Make sure you have the proper version of Python installed:
```shell
$ python --version
Python 3.7.3
```
Running the command should print something like the python version in the example. If a version of 2.x.x is printed try:
```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"
```
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:
```shell
# create a virtual environment for testing
$ python3 -m venv .
$ source bin/activate
# 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:
$ ssg --version
$ ssg languages
$ ssg parse somefile.txt --language javascript -v
$ ssg gui
```
\ No newline at end of file
[Zur Projekt README](source/README.md)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment