Skip to content

Commit

Permalink
Readme.md shouldn't cause an instant laugh-suffocation anymore
Browse files Browse the repository at this point in the history
You will have to suffer longer now (hint: read the commits - this should help you with your death-wish)
  • Loading branch information
Wolkenfarmer authored Dec 23, 2020
1 parent cd44ce6 commit 3fe5212
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Welcome to the Coding Environment!
This program is designed to compare differend codings in a simmulated communication experiment. Currently only channel codings are included.
This program is designed to compare different codings in a simulated communication experiment. Currently only channel codings are included.

<br />

Expand All @@ -10,7 +10,7 @@ This program is designed to compare differend codings in a simmulated communicat
- Controls -> Run: Button to run the communication experiment with the current setup. The same setup will be run and evaluated 1000 times and then the average gets displayed in the result table.
- Settings pages: the sub-pages of the setup model on the home page.
- Overview: Shows the location of the to be set experiment element.
- Options: Displayes the different already added options for e.g. the en/-decoder. By clicking an option its GUI will be loaded and shown in the information segment.
- Options: Displays the different already added options for e.g. the en-/decoder. By clicking an option its GUI will be loaded and shown in the information segment.
- Information: Gives information about the currently selected option. Often further settings specific for this experiemnt element can be set here like the Input in case of the information souce "User input". To set an option as the to be used experiment element for the next run of the program, "save & add" has to be pressed, which will update the color to green of the selected option in Options.

## Controls
Expand All @@ -21,8 +21,8 @@ This program is designed to compare differend codings in a simmulated communicat

## Software requirements
Uses Java 10 library. (soon to be updated)<br>
However, the releases package it's own Java hence for only running theprogram you don't need java.<br>
For compiling on other devices the classpath probabaly has to be fixed.
However, the releases package it's own Java hence for only running the program you don't need Java.<br>
For compiling on other devices the classpath probably has to be fixed.

## Further information
Further information can be extracted from the Javadoc comments - the whole code is documented.
Expand Down

0 comments on commit 3fe5212

Please sign in to comment.