Minor changes to README

Author: ArtInLines

README.md

@@ -3,10 +3,13 @@
 ### Get started
 
 This is the source code for the "SongGenerator" project from the lecture SoftwareEngineering I. \
-To run the SongGenerator, download the repository and run the `build.bat` file. \
-This will create a new `dist` folder, in which you find an `SongGenerator.bat` file. Running that file will execute the program.
+To build the SongGenerator yourself, you need to use Windows and have [Java](https://www.oracle.com/java/technologies/downloads/) and [JavaFX](https://gluonhq.com/products/javafx/) 19 or higher downloaded. \
+Then open the `build.bat` file and update the `java-path` and `javafx-path` variables if necessary. \
+They should point to your Java and JavaFX SDK-Paths respectively. \
+You can now run the `build.bat` file. \
+This will create a new `dist` folder, in which you can find the `SongGenerator.bat` file. Running that file will execute the program.
 
-### Dive in the code
+### Dive into the code
 
 For a highlevel overview > consult the architecture document (not included in this repository). \
 For an overview at package level > consult the readme inside each of the packages (music, text-analysis, text-generation, etc.) \

dictionary-creation/README.md

@@ -0,0 +1,12 @@
+<!--
+  * @author Val Richter
+ -->
+
+# Dictionary Creation
+
+The Resource Files for the Dictionary class of the SongGenerator are created here. \
+The `nouns.csv` and `verbs.csv` files are lists of german nouns and verbs. \
+These files were created via XML-Dumps from Wikipedia. \
+The `generateDict.py` script preprocesses these lists into more useful resource files, which are then used by the program.
+
+The python script doesn't need to be run anymore, since the resource files are already created. \

src/main/java/org/se/music/README.md

@@ -1,30 +1,35 @@
-
-<!--  
+<!--
   * @author Benjamin Frahm
   * @reviewer Malte Richert
- -->  
+ -->
 
 # Music
 
-This package deals with generating music, adding the text that was generated in the text component at the correct positions and persisting it in a midi file.   
+This package deals with generating music, adding the text that was generated in the text component at the correct positions and persisting it in a midi file.
 The generation is divided into 3 steps:
 
 ## 1. Template and text selection
+
 In the first step a structure-template is selected from the genre's structure-templates (stored in yml-file).
 The structure is then passed to the TextGeneration component, where fitting texts are selected.
 Thereafter, some set-up work is done, like determining the number of midi tracks needed, calculating the length of the whole song, setting the tempo, etc.
+
 ## 2. Part-filling
+
 After the structure and the texts have been selected, the actual music generation starts.
 This is done by iterating over the parts of the structure (intro, chorus, verse, etc.) and generating the notes that are to be played by the instruments specified in the part.
 The different instruments are treated as follows:
-- Chords: play the chord progression of the part in the right hand, play root note of the current chord in the left hand.
-- Bass: play a bass line that contains transitions between the chords of the part's progression
-- Drum: play a drumbeat selected from the drumBeat-templates
-- Melody: Every part has a 4- or 12-bar theme, which is then varied and applied in slightly different versions
+
+-   Chords: play the chord progression of the part in the right hand, play root note of the current chord in the left hand.
+-   Bass: play a bass line that contains transitions between the chords of the part's progression
+-   Drum: play a drumbeat selected from the drumBeat-templates
+-   Melody: Every part has a 4- or 12-bar theme, which is then varied and applied in slightly different versions
 
 Since some parts of the music are being reused (equal parts) or varied (theme variations), the music is not directly written as midi, but abstracted and stored as instances of the MidiPlayable class.
 
 The specific midi instrument number to be associated with the abstract instruments (like chords, bass, etc.) is specified in a config file (instrument_mapping.yml).
+
 ## 3. Midi-File creation
+
 After all MidiPlayables have been created, the conversion to actual midi begins, by iterating over the parts of the song in order, as specified in structure template, and writing the MidiPlayables' content into one Midi-Sequence-Object.
 After this is done, the text is added at the required positions (indicated by "vocals" instrument in the structure).

src/main/java/org/se/text/generation/README.md

@@ -1,21 +1,24 @@
-
-<!--  
+<!--
   * @author Olivier Stenzel
--->  
+-->
 
 # Text-Generation
+
 This package deals with the generation of a song text based on a `Structure`, a `MoodType`, a `TermCollection` and several templates. The structure is generated in the music package and the MoodType, as well as the TermCollection, based on the text given by the user.
 
 ## How the generation works
 
-### Get an overview of the requirements 
+### Get an overview of the requirements
+
 First, the order, the naming of the parts (intro, chorus, verse, etc.) and the number of bars of the song are saved on the basis of the passed structure.
 Based on these, one part after the other is created and added to the song text.
 
 ### Create a strophe based on the part-requirements
+
 A random strophe-template that has not yet been used is loaded from a collection of templates, written in several YAML-files.
 This strophe-template contains placeholders with requirements, which are analyzed and replaced by a matching word, stored in the TermCollaction.
 
 ### Passing the song text
+
 For further processing, the song text is split and provided with additional information.
 At the end the TextGenerator returns a list for each part which assigns the generated song text and its number of syllables to each bar of the part.