Browse Source

add README

Noah 4 years ago
parent
commit
b9ac8dc77e
3 changed files with 33 additions and 0 deletions
  1. 29 0
      README.md
  2. BIN
      media/readme-example.png
  3. 4 0
      tests/readme-example

+ 29 - 0
README.md

@@ -0,0 +1,29 @@
+# gizmo
+**gizmo** is a simple toolbox to create some simple melodies using python. The beauty about is, that you only need *a single motive* to create a little song.
+
+*Note:* This program uses the [music21](https://github.com/cuthbertLab/music21) library.
+
+## Dependencies
+You can install the only python module that is not in the default library using pip:
+
+	pip install music21
+
+## the 'gizmo notation'
+For a simple toolkit you need a simple notation that abides to the unix philsphoy. So we made a now one that consists simply of *lines in a plain text file*.
+
+Every line contains the information about *one note*. Seperated by apostrophes there are different attributes specified for each note. Every Attribute seperated like this is called a **'part'**. 
+- The first part is a four characters long float that contains the *length* of the note in quarters.
+- The second part is two to three chars long. The fist character is the Note value (capitalized) and the second one the octave (as a integer). The third char is optional and just the key signature in the form of either "#" or "-".
+
+Here an example in the *gizmo notation*:
+
+	1.00,G4
+	1.00,E4
+	0.50,D4
+	1.00,C#4
+
+Now the same example in *sheet music*:
+![](media/readme-example.png)
+
+## Rendering
+After you fully processed your music in the gizmo notation you can run it through the script called *final-converter* to export your work as a **.musicXML** file. This file can be viewed and further edited/processed in other free software like [MuseScore](https://github.com/musescore/MuseScore).

BIN
media/readme-example.png


+ 4 - 0
tests/readme-example

@@ -0,0 +1,4 @@
+1.00,G4
+1.00,E4
+0.50,D4
+1.00,C#4