README.md: add a trailing slash to directories

[vidi-player.git] / README.md

diff --git a/README.md b/README.md
index 322615a..4c4180c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-vidi-player creates a video timeline starting from a MIDI file.
+vidi-timeline creates a video timeline starting from a MIDI file.
 
 The video clips are taken from a "VideoFont" in which each sample clip
 corresponds to a note. The samples are arranged following the time and value of
 the notes in the MIDI file.
 
-vidi-player allows to create more easily videos like these:
+vidi-timeline allows to create more easily videos like these:
 
 * Lasse Gjertsen - Hyperactive -  https://youtu.be/o9698TqtY4A
 * Vittorio Saggiomo - Mario Bros Column Chromatography - https://youtu.be/mxi3z2vDV_0
@@ -13,19 +13,22 @@ vidi-player allows to create more easily videos like these:
 Examples of use
 ===============
 
+vidi-timeline.py
+----------------
+
 Create a synthetinc VideoFont:
 
-    $ ./create_test_videofont.py videofont
+    $ ./create_test_videofont.py videofont/
 
 
 Play the timeline from a MIDI file using the samples from the VideoFont:
 
-    $ ./vidi-player.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont
+    $ ./vidi-timeline.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/
 
 
 Save the timeline to be edited somewhere else (e.g. in PiTiVi):
 
-    $ ./vidi-player.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/ Beyer_008.xges
+    $ ./vidi-timeline.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/ Beyer_008.xges
 
 
 Render the timeline to a video file:
@@ -33,6 +36,24 @@ Render the timeline to a video file:
     $ ges-launch-1.0 --load Beyer_008.xges --outputuri Beyer_008.webm --format="video/webm:video/x-vp8:audio/x-vorbis"
 
 
+vidi-player.py
+--------------
+
+Play a midi file in real time (if the CPU and the disk can keep up):
+
+    $ ./vidi-player.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/
+
+
+vidi-sampler.py
+---------------
+
+Play samples from the note hit on a midi controller:
+
+    $ xset -r && vkeybd && xset r on &
+    $ ./vidi-sampler.py 'Virtual Keyboard' videofont/
+    $ fg
+
+
 Similar projects
 ================