diff --git a/Audiziler/pom.xml b/Audiziler/pom.xml index 8cf53ef..816992b 100644 --- a/Audiziler/pom.xml +++ b/Audiziler/pom.xml @@ -18,7 +18,7 @@ junit junit - 4.12 + 4.13.1 test diff --git a/README.md b/README.md index fe852b5..17dd918 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,16 @@ -Repositorio sisältää Helsingin yliopiston ohjelmistotekniikan kurssin harjoitustyönä tehdyn sovelluksen. +# Audiziler -![](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/kuvat/visualisaatio.png) +![](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/kuvat/audiziler.png) -# Harjoitustyö +A sound visualizer app I made as a software dev course project. The UI-framework used is JavaFX. -Harjoitustyö on äänen visualisointisovellus. Sovellukseen valitaan äänitiedosto ja sovellus piirtää äänen taajuusmagnitudeihin reagoivan visualisaation. +## Features -[Loppupalautus](https://github.com/Veikkosuhonen/ot-harjoitustyo/releases/tag/loppupalautus) +- Simple and easy UI +- Audio file selection and playback +- 4 visualization styles to choose during playback +- 8 parameters to control visualization in real-time from the UI +- Dynamically changing visualization parameters +- [Instructions](https://github.com/Veikkosuhonen/Audiziler/blob/master/dokumentaatio/Instructions.md) (possibly outdated) -[Pre-release](https://github.com/Veikkosuhonen/ot-harjoitustyo/releases/tag/v0.1-alpha) - -[Harjoitustyön toimivuudesta laitoksen koneilla](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/toimivuus_laitoksen_koneilla.md) - -## Dokumentaatio - -[INSTRUCTIONS](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/Instructions.md) - -[Vaatimusmäärittely](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/vaatimusmäärittely.md) - -[Arkkitehtuuri](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/arkkitehtuuri.md) - -[Testausraportti](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/testausraportti.md) - -[Työaikakirjanpito](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/tyoaikakirjanpito.md) - -## Komentorivitoiminnot -### Testaus - -Testit suoritetaan komennolla - -`mvn test` - -Testikattavuusraportti luodaan komennolla - -`mvn test jacoco:report` - -Kattavuusraportti avataan tiedostosta target/site/jacoco/index.html -### Jar-tiedoston generointi - -`mvn package` - -generoi hakemistoon target suoritettavan jar-tiedoston Audiziler-1.0-SNAPSHOT.jar -### JavaDocin generointi - -`mvn javadoc:javadoc` - -JavaDoc avataan tiedostosta target/site/apidocs/index.html -### Checkstyle - - `mvn checkstyle:checkstyle` - -Checkstyle-raportti avataan tiedostosta target/site/checkstyle.html +The repository also contains the documentation made for the software dev course (in Finnish) diff --git a/README_FIN.md b/README_FIN.md new file mode 100644 index 0000000..fe852b5 --- /dev/null +++ b/README_FIN.md @@ -0,0 +1,53 @@ +Repositorio sisältää Helsingin yliopiston ohjelmistotekniikan kurssin harjoitustyönä tehdyn sovelluksen. + +![](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/kuvat/visualisaatio.png) + +# Harjoitustyö + +Harjoitustyö on äänen visualisointisovellus. Sovellukseen valitaan äänitiedosto ja sovellus piirtää äänen taajuusmagnitudeihin reagoivan visualisaation. + +[Loppupalautus](https://github.com/Veikkosuhonen/ot-harjoitustyo/releases/tag/loppupalautus) + +[Pre-release](https://github.com/Veikkosuhonen/ot-harjoitustyo/releases/tag/v0.1-alpha) + +[Harjoitustyön toimivuudesta laitoksen koneilla](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/toimivuus_laitoksen_koneilla.md) + +## Dokumentaatio + +[INSTRUCTIONS](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/Instructions.md) + +[Vaatimusmäärittely](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/vaatimusmäärittely.md) + +[Arkkitehtuuri](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/arkkitehtuuri.md) + +[Testausraportti](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/testausraportti.md) + +[Työaikakirjanpito](https://github.com/Veikkosuhonen/ot-harjoitustyo/blob/master/dokumentaatio/tyoaikakirjanpito.md) + +## Komentorivitoiminnot +### Testaus + +Testit suoritetaan komennolla + +`mvn test` + +Testikattavuusraportti luodaan komennolla + +`mvn test jacoco:report` + +Kattavuusraportti avataan tiedostosta target/site/jacoco/index.html +### Jar-tiedoston generointi + +`mvn package` + +generoi hakemistoon target suoritettavan jar-tiedoston Audiziler-1.0-SNAPSHOT.jar +### JavaDocin generointi + +`mvn javadoc:javadoc` + +JavaDoc avataan tiedostosta target/site/apidocs/index.html +### Checkstyle + + `mvn checkstyle:checkstyle` + +Checkstyle-raportti avataan tiedostosta target/site/checkstyle.html diff --git a/dokumentaatio/kuvat/audiziler.png b/dokumentaatio/kuvat/audiziler.png new file mode 100644 index 0000000..a215f94 Binary files /dev/null and b/dokumentaatio/kuvat/audiziler.png differ