|
@@ -5,15 +5,17 @@ MadHelix is a Java Swing-based graphical frontend for [SoundHelix](https://www.s
|
|
|
Run the ant command in the main folder and then run the generated MadHelix.jar file.
|
|
|
|
|
|
## How to Use
|
|
|
-1. Once the MadHelix interface shows, it should say 'Ready' at the top. If it says anything else, regardless of whether the rest of the program works, please report it on the Issues page.
|
|
|
-2. Enter any text in the 'Song name' field and choose a style.
|
|
|
-3. Click the play button to listen to the result. SoundHelix will then load and the generated song will begin playing. If SoundHelix does not load after 30 seconds, please report it.
|
|
|
+1. If upgrading from 0.3.0 or older, run `./utils/history_converter.py` to preserve song history. This step can be ignored if using MadHelix for the first time.
|
|
|
+2. Once the MadHelix interface shows, it should say 'Ready' at the top. If it says anything else, regardless of whether the rest of the program works, please report it on the Issues page.
|
|
|
+3. Enter any text in the 'Song name' field and choose a style. Alternatively, if the song name is empty, SoundHelix will generate a song title.
|
|
|
+4. Click the play button to listen to the result. SoundHelix will then load and the generated song will begin playing. If SoundHelix does not load after 30 seconds, please report it.
|
|
|
|
|
|
## Credits
|
|
|
* MadHelix is developed by UltrasonicMadness
|
|
|
* SoundHelix is developed by Thomas Schürger
|
|
|
-* The JSON library, json-simple, is developed by Yidong Fang, Chris Nokleberg and Dave Hughes
|
|
|
-* The icons are made by the [GNOME Project](http://www.gnome.org/) as part of version 3.28.0 of the [Adwaita Icon Theme](https://gitlab.gnome.org/GNOME/adwaita-icon-theme).
|
|
|
+* The icons are made by the [GNOME Project](http://www.gnome.org/) as part of version 44 of the [Adwaita Icon Theme](https://gitlab.gnome.org/GNOME/adwaita-icon-theme).
|
|
|
|
|
|
## License
|
|
|
MadHelix is available under the GNU General Public License, version 3 only.
|
|
|
+
|
|
|
+Copyright © 2017-2019, 2023 UltrasonicMadness.
|