Home Explore Help
Sign In
noah
/
gizmo
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Browse Source

added documentation generator

Noah 4 years ago
parent
b9ac8dc77e
commit
76a5976a57
4 changed files with 156 additions and 1 deletions
Unified View Show Diff Stats
  1. 3 1
      README.md
  2. 78 0
      doc/build-doc
  3. 75 0
      doc/documentation.html
  4. BIN
      doc/documentation.pdf

+ 3 - 1
README.md
View File 

@@ -11,7 +11,8 @@ You can install the only python module that is not in the default library using
 
 ## the 'gizmo notation'
 
 ## 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*.
 
 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'**. 
+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 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 "-".
 
 - 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 "-".
 
 
 
@@ -23,6 +24,7 @@ Here an example in the *gizmo notation*:
 
 	1.00,C#4
 
 	1.00,C#4
 
 
 
 Now the same example in *sheet music*:
 
 Now the same example in *sheet music*:
 
+
 
 ![](media/readme-example.png)
 
 ![](media/readme-example.png)
 
 
 
 ## Rendering
 
 ## Rendering

+ 78 - 0
doc/build-doc
View File 

@@ -0,0 +1,78 @@
 
+#!/bin/sh
 
+
 
+# script to convert a .md file (specified as a commandline argument)
 
+# into a html + pdf documentation using 'markdown' and 'pandoc'
 
+
 
+# exit if no argument given
 
+[ -z "$1" ] && { echo "Error: Usage: build-doc [filename]"; exit 1; }
 
+# compiling md to html (raw)
 
+
 
+markdown -o "precomp.html" "$1"
 
+
 
+# get directory of script
 
+basename="$(dirname $0)"
 
+
 
+# add code background + correct media path (for pandoc)
 
+# (made crossplatfarm by assuming BSD-like SED)
 
+sed "s/<pre><code>/<div><pre><code>/g;
 
+	s/<\/code><\/pre>/<\/code><\/pre><\/div>/g;
 
+	s/media\//\.\.\/media\//g;" precomp.html > tmp.html &&
 
+	mv tmp.html precomp.html
 
+
 
+pre="<!DOCTYPE html>
 
+<html>
 
+<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">
 
+<title>gizmo documentation</title>
 
+<style>
 
+body {
 
+	padding-top: 100px;
 
+	padding-bottom: 10px;
 
+	max-width: 800px;
 
+	margin: auto;
 
+}
 
+
 
+.over {
 
+	border: 1px solid black;
 
+	padding: 20px;
 
+	border-radius: 5px;	
+	background: white;
 
+	margin-bottom: 50px;
 
+}
 
+
 
+div {
 
+	padding: 1px;
 
+	padding-left: 10px;
 
+	background: lightgrey;
 
+}
 
+</style>
 
+</head>
 
+<body>
 
+<div class=\"over\">"
 
+
 
+precomp=$(cat "precomp.html")
 
+
 
+after="</div>
 
+</body>
 
+<hr>
 
+<center>
 
+	follow this project on 
+	<a href="https://github.com/noahvogt/gizmo">github</a>
 
+</center>
 
+</html>"
 
+
 
+# cat together all pieces for the output
 
+echo "$pre$precomp$after" > "$basename/documentation.html"
 
+
 
+# correct media path (for pandoc)
 
+# (made crossplatfarm by assuming BSD-like SED)
 
+if [ $basename != "." ]; then
 
+	sed "s/\"\.\.\//\"/g;" "$basename/documentation.html" > tmp.html
 
+	mv tmp.html "$basename/pandoc.html"
 
+else
 
+	cp "$basename/documentation.html" "$basename/pandoc.html"
 
+fi
 
+
 
+pandoc "$basename/pandoc.html" -f html -t pdf -o "$basename/documentation.pdf"
 
+
 
+# remove temporary file
 
+	rm precomp.html "$basename/pandoc.html"

+ 75 - 0
doc/documentation.html
View File 

@@ -0,0 +1,75 @@
 
+<!DOCTYPE html>
 
+<html>
 
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
 
+<title>gizmo documentation</title>
 
+<style>
 
+body {
 
+	padding-top: 100px;
 
+	padding-bottom: 10px;
 
+	max-width: 800px;
 
+	margin: auto;
 
+}
 
+
 
+.over {
 
+	border: 1px solid black;
 
+	padding: 20px;
 
+	border-radius: 5px;	
+	background: white;
 
+	margin-bottom: 50px;
 
+}
 
+
 
+div {
 
+	padding: 1px;
 
+	padding-left: 10px;
 
+	background: lightgrey;
 
+}
 
+</style>
 
+</head>
 
+<body>
 
+<div class="over"><h1>gizmo</h1>
 
+
 
+<p><strong>gizmo</strong> is a simple toolbox to create some simple melodies using python. The beauty about is, that you only need <em>a single motive</em> to create a little song.</p>
 
+
 
+<p><em>Note:</em> This program uses the <a href="https://github.com/cuthbertLab/music21">music21</a> library.</p>
 
+
 
+<h2>Dependencies</h2>
 
+
 
+<p>You can install the only python module that is not in the default library using pip:</p>
 
+
 
+<div><pre><code>pip install music21
 
+</code></pre></div>
 
+
 
+<h2>the &lsquo;gizmo notation&rsquo;</h2>
 
+
 
+<p>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 <em>lines in a plain text file</em>.</p>
 
+
 
+<p>Every line contains the information about <em>one note</em>. Seperated by apostrophes there are different attributes specified for each note. Every attribute seperated like this is called a <strong>&lsquo;part&rsquo;</strong>:</p>
 
+
 
+<ul>
 
+<li>The first part is a four characters long float that contains the <em>length</em> of the note in quarters.</li>
 
+<li>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 &ldquo;#&rdquo; or &ldquo;-&rdquo;.</li>
 
+</ul>
 
+
 
+
 
+<p>Here an example in the <em>gizmo notation</em>:</p>
 
+
 
+<div><pre><code>1.00,G4
 
+1.00,E4
 
+0.50,D4
 
+1.00,C#4
 
+</code></pre></div>
 
+
 
+<p>Now the same example in <em>sheet music</em>:</p>
 
+
 
+<p><img src="../media/readme-example.png" alt="" /></p>
 
+
 
+<h2>Rendering</h2>
 
+
 
+<p>After you fully processed your music in the gizmo notation you can run it through the script called <em>final-converter</em> to export your work as a <strong>.musicXML</strong> file. This file can be viewed and further edited/processed in other free software like <a href="https://github.com/musescore/MuseScore">MuseScore</a>.</p></div>
 
+</body>
 
+<hr>
 
+<center>
 
+	follow this project on 
+	<a href=https://github.com/noahvogt/gizmo>github</a>
 
+</center>
 
+</html>

BIN
doc/documentation.pdf
View File