documentation updated

abudaan · Jan 4, 2015 · be8c586 · be8c586
1 parent 5fa21f0
commit be8c586
Show file tree

Hide file tree

Showing 7 changed files with 110 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ heartbeat
 
 Heartbeat is a MIDI/Audio sequencer for your browser. Heartbeat has no GUI. It is intended to be used as an engine behind your application. Heartbeat is set up very flexible so you can make any kind of application on top of it; a game, an online DAW, artistic sites, music science experiments and so on. [Read more](http://abudaan.github.io/heartbeat/docs).
 
-So far heartbeat has been used in 2 projects:
+So far heartbeat has been used in 2 [MusicFirst](https://musicfirst.com/splash) projects:
 - [Groovy](https://musicfirst.com/groovy-music)
 - [Morton Subotnick’s Music Academy](https://musicfirst.com/msma)
 
@@ -13,7 +13,7 @@ So far heartbeat has been used in 2 projects:
 ####key features
 
 
-######MIDI:
+######MIDI
 - create MIDI file from scratch
 - import existing MIDI files
 - save MIDI data to a file (SMF 1.0)
@@ -25,6 +25,7 @@ So far heartbeat has been used in 2 projects:
 - support for tempo and time signature changes
 - multiple songs can be loaded and played back at the same time
 - MIDI data can be shared or moved across songs, tracks and parts very easily
+- import MusicXML files (in progress)
 
 
 ######Audio
@@ -36,7 +37,7 @@ So far heartbeat has been used in 2 projects:
 - transpose audio (experimental)
 
 
-######Instruments:
+######Instruments
 - support for multiple velocity layers
 - support for control change events: sustain pedal, volume and panning
 - sustained instruments (like organ, stings, pads)

diff --git a/css/home_page.css b/css/home_page.css
@@ -48,22 +48,22 @@ h1{
 h2{
     font-weight: bold;
     font-size: 20px;
-    margin-top: 30px;
+    margin-top: 40px;
     margin-bottom: 20px;
     color: #333;
 }
 h3{
     font-weight: bold;
     font-size: 18px;
     margin-top: 30px;
-    margin-bottom: 20px;
+    margin-bottom: 25px;
     color: #333;
 }
 h4{
     font-size: 15px;
     color: #555;
     font-weight: 700;
-    margin-bottom: 10px;
+    margin-bottom: 20px;
 }
 #logo{
     margin-top: 30px;
@@ -161,3 +161,10 @@ a.black{
     color: #555;
     text-decoration: underline;
 }
+p.center{
+    font-size: 110%;
+    text-align: center;
+}
+p.center a{
+    /*text-decoration: underline;*/
+}
diff --git a/docs/create-note/index.html b/docs/create-note/index.html
@@ -47,7 +47,7 @@
 <h2>createNote(parameter1, [parameter2, noteNameMode])</h2>
 
 <blockquote>
-  <p>defined in <a href="https://bitbucket.org/abudaan/heartbeat/src/a7db64b7346f9c922f518fe83758f2a3d7db5452/src/heartbeat/note.js">note.js</a><br>
+  <p>defined in <a href="https://github.com/abudaan/heartbeat/blob/gh-pages/src/heartbeat/note.js">note.js</a><br>
   related methods:<br>
   <a href="#!Sequencer/getNoteName">sequencer.getNoteName()</a><br>
   <a href="#!Sequencer/getNoteOctave">sequencer.getNoteOctave()</a><br>

diff --git a/docs/features/index.html b/docs/features/index.html
@@ -42,47 +42,54 @@
     </div>
     <div id="main">
         <div id="content">
-<h1>Features</h1>
+<h1>Key features</h1>
 
 <p><a name="MIDI"></a></p>
 
 <h3>MIDI:</h3>
 
 <ul>
-<li>create midi file from scratch</li>
-<li>import existing midi files</li>
-<li>save midi data to file (SMF 1.0)</li>
-<li>record midi (only in browsers that support the WebMIDI API)</li>
+<li>create MIDI file from scratch</li>
+<li>import existing MIDI files</li>
+<li>save MIDI data to a file (SMF 1.0)</li>
+<li>record MIDI (only in browsers that support the WebMIDI API or have the <a href="http://jazz-soft.net">Jazz plugin</a> installed)</li>
+<li>play back MIDI via external hardware, virtual MIDI ports or included softsynths or sample player</li>
 <li>quantize and fixed length functions</li>
-<li>quantize undo history</li>
-<li>you can set the PPQ value of a file</li>
+<li>keep a history of edit actions very easily</li>
+<li>set the PPQ value of a file or song</li>
 <li>support for tempo and time signature changes</li>
-<li>multiple songs to be loaded and played back at the same time</li>
-<li>midi data can be shared or moved across songs, tracks and parts very easily</li>
+<li>multiple songs can be loaded and played back at the same time</li>
+<li>MIDI data can be shared or moved across songs, tracks and parts very easily</li>
+<li>import MusicXML files (in progress)</li>
+</ul>
+
+<p><a name="Audio"></a></p>
+
+<h3>Audio</h3>
+
+<ul>
+<li>volume and panning controller per track</li>
+<li>volume controller per song and one master volume output with compression</li>
+<li>channel effects per track: reverb, panning, autopan and more to come</li>
+<li>record audio directly in your browser</li>
+<li>save audio recordings as wav, mp3 or base64 file</li>
+<li>transpose audio (experimental)</li>
 </ul>
 
 <p><a name="Instruments"></a></p>
 
 <h3>Instruments:</h3>
 
 <ul>
-<li>support multiple velocity layers</li>
-<li>support control change events for sustain pedal, volume and panning</li>
+<li>support for multiple velocity layers</li>
+<li>support for control change events: sustain pedal, volume and panning</li>
 <li>sustained instruments (like organ, stings, pads)</li>
 <li>keyscaling for release and panning</li>
 <li>configurable release duration and envelope type</li>
 <li>support for .sfz format (upto a certain level)</li>
 <li>instrument samples can be transposed at runtime (experimental)</li>
-</ul>
-
-<p><a name="Audio"></a></p>
-
-<h3>Audio</h3>
-
-<ul>
-<li>volume and panning controller per track</li>
-<li>volume controller per song and one master volume output with compression</li>
-<li>channel effects per track: reverb, panning, autopan and more to come</li>
+<li>12 sample based instruments included for the sample player (570MB of samples)</li>
+<li>1 simple sinewave synthesizer included as fallback instrument</li>
 </ul>
         </div><!-- end of div container-->
     </div><!-- end of div main-->

diff --git a/docs/find-events-and-notes/index.html b/docs/find-events-and-notes/index.html
@@ -47,7 +47,7 @@
 <h1>Find Events</h1>
 
 <blockquote>
-  <p>defined in <a href="https://bitbucket.org/abudaan/heartbeat/src/a7db64b7346f/src/heartbeat/find_event.js">find_event.js</a><br/>
+  <p>defined in <a href="https://github.com/abudaan/heartbeat/blob/gh-pages/src/heartbeat/find_event.js">find_event.js</a><br/>
   related methods:<br/>
   <a href="#findNote">findNote()</a><br/></p>
 </blockquote>

diff --git a/docs/statistics/index.html b/docs/statistics/index.html
@@ -49,7 +49,7 @@ <h1>Event Statistics</h1>
 <h3>getStats(searchstring)</h3>
 
 <blockquote>
-  <p>defined in <a href="https://bitbucket.org/abudaan/heartbeat/src/a7db64b7346f/src/heartbeat/event_statistics.js">event_statistics.js</a><br/>
+  <p>defined in <a href="https://github.com/abudaan/heartbeat/blob/gh-pages/src/heartbeat/event_statistics.js">event_statistics.js</a><br/>
   related methods:<br/>
   <a href="/docs/find_event">findEvent()</a><br/>
   <a href="/docs/find_note">findNote()</a><br/></p>

diff --git a/index.html b/index.html
@@ -43,10 +43,73 @@
           Heartbeat is set up very flexible so you can make any kind of application on top of it; a game, an online DAW, artistic sites, music science experiments and so on.
         </p>
         <p>
-          So far heartbeat has been used in 2 MusicFirst projects: <a href="https://musicfirst.com/groovy-music">Groovy</a> and <a href="https://musicfirst.com/msma">Morton Subotnick’s Music Academy</a>
+          So far heartbeat has been used in 2 MusicFirst projects: <a href="https://musicfirst.com/groovy-music">Groovy</a> and <a href="https://musicfirst.com/msma">Morton Subotnick’s Music Academy</a>.
+<!--
+          So far heartbeat has been used in 2 <a href="https://musicfirst.com">MusicFirst</a> projects:
+          <ul>
+            <li><a href="https://musicfirst.com/groovy-music">Groovy</a></li>
+            <li><a href="https://musicfirst.com/msma">Morton Subotnick’s Music Academy</a></li>
+          </ul>
+-->
         </p>
+
+<!--
+
+<h2>key features:</h2>
+
+<p><a name="MIDI"></a></p>
+
+<h3>MIDI</h3>
+
+<ul>
+<li>create MIDI file from scratch</li>
+<li>import existing MIDI files</li>
+<li>save MIDI data to a file (SMF 1.0)</li>
+<li>record MIDI (only in browsers that support the WebMIDI API or have the <a href="http://jazz-soft.net">Jazz plugin</a> installed)</li>
+<li>play back MIDI via external hardware, virtual MIDI ports or included softsynths or sample player</li>
+<li>quantize and fixed length functions</li>
+<li>keep a history of edit actions very easily</li>
+<li>set the PPQ value of a file or song</li>
+<li>support for tempo and time signature changes</li>
+<li>multiple songs can be loaded and played back at the same time</li>
+<li>MIDI data can be shared or moved across songs, tracks and parts very easily</li>
+<li>import MusicXML files (in progress)</li>
+</ul>
+
+<p><a name="Audio"></a></p>
+
+<h3>Audio</h3>
+
+<ul>
+<li>volume and panning controller per track</li>
+<li>volume controller per song and one master volume output with compression</li>
+<li>channel effects per track: reverb, panning, autopan and more to come</li>
+<li>record audio directly in your browser</li>
+<li>save audio recordings as wav, mp3 or base64 file</li>
+<li>transpose audio (experimental)</li>
+</ul>
+
+<p><a name="Instruments"></a></p>
+
+<h3>Instruments</h3>
+
+<ul>
+<li>support for multiple velocity layers</li>
+<li>support for control change events: sustain pedal, volume and panning</li>
+<li>sustained instruments (like organ, stings, pads)</li>
+<li>keyscaling for release and panning</li>
+<li>configurable release duration and envelope type</li>
+<li>support for .sfz format (upto a certain level)</li>
+<li>instrument samples can be transposed at runtime (experimental)</li>
+<li>12 sample based instruments included for the sample player (570MB of samples)</li>
+<li>1 simple sinewave synthesizer included as fallback instrument</li>
+</ul>
+
+-->
         <p>
-          <a class="black" href="/heartbeat/docs/about-heartbeat/">Read more</a>
+          <!-- <a class="black" href="/heartbeat/docs/features/">Key features</a> -->
+          Check the list of <a href="/heartbeat/docs/features/">key features</a>.
+          <!-- <a href="/heartbeat/docs/about-heartbeat/">Read more</a> -->
         </p>
       </div>
     </div>