README.md

German Version below

MorseProject

This project is created as part of the 'Software Engineering' lecture in winter semester 2021 in the Applied Computer Science course at DHBW Mannheim. The aim is to transmit Morse codes between two or more devices via sound.

Requirements

The final software product is compiled as a JAR archive with Java version 17. The corresponding Java version (JRE) is therefore required to run the software on all supported platforms.

Once the JAR archive has been downloaded, no installation of the application is necessary.

Start Application

From discussions with the client, it appears that the finished application will NOT be installed on the client's systems by the contractor. As a gesture of goodwill, the contractor is willing to help in case of problems with the start of the software. Following are some ways that can lead to the successful launch of the software:

• If the PATH variable was filled correctly during the installation of Java, the application can be started with a double click on the file.
• Run JAR via Rigth CLick > Open with > Select correct JRE
• If none of the above methods work, which unfortunately can happen especially if several Java versions are installed on the system, it is recommended to start the application via the console (unter Windows):
  1. open console e.g. Win + R > enter "cmd" > OK
  2. enter the following command:

     C:\PATH\TO\JRE\bin\java.exe -jar C:\PATH\TO\JAR\MorseProject.jar
     

Possible Errors

• If the OS is trying to open the JAR file with the wrong Java Version, errors like this can occur:

  

  Possible Solution: modify PATH variable to point to the correct version (see) or use another way to start the application.

Contributors

• Mark M.
• Hassan El-Khalil
• Frederik Wolter
• Daniel Czeschner
• Kai Grübener
• Lucas Schaffer

---

German Version

MorseProjekt

Dieses Projekt wird im Rahmen der Vorlesung 'Software-Engineering' im Wintersemester 2021 im Studiengang 'Angewandte Informatik' an der DHBW Mannheim erstellt. Ziel ist es, Morsecodes zwischen zwei oder mehreren Geräten per Ton zu übertragen.

Anforderungen

Das fertige Produkt wird als JAR-Archiv mit Java Version 17 kompiliert. Die entsprechende Java-Version (JRE) ist daher erforderlich, um die Software auf allen unterstützten Plattformen auszuführen.

Nach dem Download des JAR-Archivs ist keine Installation der Anwendung erforderlich.

Anwendung starten

Aus Gesprächen mit dem Auftraggeber geht hervor, dass die fertige Anwendung vom Auftragnehmer NICHT auf den Systemen des Auftraggebers installiert werden wird. Aus Kulanz ist der Auftragnehmer bereit, bei Problemen mit dem Start der Software zu helfen. Im Folgenden sind einige Möglichkeiten aufgeführt, die zu einem erfolgreichen Start der Software führen können:

• Wurde bei der Installation von Java die Variable PATH korrekt gefüllt, kann die Anwendung mit einem Doppelklick auf die Datei gestartet werden.
• JAR über Rigth CLick > Öffnen mit > Richtige JRE auswählen starten
• Wenn keine der oben genannten Methoden funktioniert, was leider vorkommen kann, insbesondere wenn mehrere Java-Versionen auf dem System installiert sind, empfiehlt es sich, die Anwendung über die Konsole (unter Windows) zu starten:
  1. Konsole öffnen z.B. Win + R > "cmd" eingeben > OK
  2. Geben Sie den folgenden Befehl ein:

     C:\Pfad\zu\JRE\bin\java.exe -jar C:\Pfad\zu\JAR\MorseProject.jar
     

Mögliche Fehler

• Wenn das Betriebssystem versucht, die JAR-Datei mit der falschen Java-Version zu öffnen, können Fehler wie dieser auftreten:

  

  Mögliche Lösung: Ändern Sie die PATH-Variable so, dass sie auf die richtige Version verweist (siehe) oder verwenden Sie einen anderen Weg, um die Anwendung zu starten.

Mitwirkende

• Mark M.
• Hassan El-Khalil
• Frederik Wolter
• Daniel Czeschner
• Kai Grübener
• Lucas Schaffer