r12886 - packages/trunk/pianobooster/debian

Tue Nov 29 21:28:13 UTC 2011

Author: miriam
Date: 2011-11-29 21:28:13 +0000 (Tue, 29 Nov 2011)
New Revision: 12886

Added:
   packages/trunk/pianobooster/debian/pianobooster.6
   packages/trunk/pianobooster/debian/pianobooster.manpages
Modified:
   packages/trunk/pianobooster/debian/README.Debian
   packages/trunk/pianobooster/debian/control
Log:
Added manpage and readme text, and fixed the description



Modified: packages/trunk/pianobooster/debian/README.Debian
===================================================================

--- packages/trunk/pianobooster/debian/README.Debian	2011-11-29 15:47:07 UTC (rev 12885)
+++ packages/trunk/pianobooster/debian/README.Debian	2011-11-29 21:28:13 UTC (rev 12886)
@@ -1,6 +1,41 @@
 pianobooster for Debian
 -----------------------
 
+To hear the sound Piano Booster needs a MIDI sound generator, there are two
+different General Midi sound generators available on Linux, 'fluidsynth' and
+'timidity'.
+
+To install fluidsynth you must install the following packages: 'fluidsynth',
+'fluid-soundfont-gm' and 'fluid-soundfont-gs', using your favourite package
+manager.
+
+To start the fluidsynth sound generator copy and paste the following command
+line:
+
+fluidsynth -C 0 -R 0 -r 22050 -c 6 -z 128 -l -a alsa -o audio.alsa.device=plughw:0 -o midi.alsa_seq.id=fs /usr/share/sounds/sf2/FluidR3_GM.sf2 /usr/share/sounds/sf2/FluidR3_GS.sf2
+
+If you have a fast machine, you can leave out the flags '-C 0 -R 0 -r 22050'
+which turns off the reverb, chorus and reduce the sample rate.
+
+The flags '-c 6 -z 128' control the latency. Try '-c 5 -z 128' for less
+latency but at the risk of audio drop outs.
+
+The flags '-o audio.alsa.device=plughw:0' bypasses the Pulse Audio layer
+which might cause a lot of latency delay, but unfortunately these flags
+may also bypass the desktop volume controls.
+
+For more information on running fluidsynth with low latency see this page.
+
+http://fluidsynth.resonance.org/trac/wiki/LowLatency
+
+On PianoBooster set the Setup/Midi Setup/Midi Output Device: to "FLUID Synth (fs):0"
+
+If you get problems with unsteady playback or the audio cutting out then try
+closing all other programs, turning off your wireless network and unplug any
+network cable.
+
+-----------------------
+
 Clarification of RtMidi's license by Gary Scavone <gary.scavone at mcgill.ca>:
 
 Subject: Re: About RtMidi License

Modified: packages/trunk/pianobooster/debian/control
===================================================================
--- packages/trunk/pianobooster/debian/control	2011-11-29 15:47:07 UTC (rev 12885)
+++ packages/trunk/pianobooster/debian/control	2011-11-29 21:28:13 UTC (rev 12886)
@@ -7,23 +7,30 @@
  mesa-common-dev, libglu1-mesa-dev, libasound2-dev
 Standards-Version: 3.9.2
 Homepage: http://pianobooster.sourceforge.net/
+Vcs-Svn: svn://svn.debian.org/svn/pkg-games/packages/trunk/pianobooster/
+Vcs-Browser: http://svn.debian.org/wsvn/pkg-games/packages/trunk/pianobooster/?op=log
 
 Package: pianobooster
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Suggests: pianobooster-dbg (= ${binary:Version})
-Description: a new way to learn the piano just by playing a game
+Description: learn the piano just by playing a game
  Piano Booster is a new way to learn the piano just by playing a game. 
  It takes elements of the game Guitar Hero but now it uses a real piano
  keyboard and the game has been turned sideways so the notes scroll along
  a musical stave. So instead of pressing buttons on a fake guitar you end
  up learning to play a real musical instrument: the piano.
+ .
+ To run Piano Booster you need a MIDI Piano Keyboard and a MIDI interface
+ for the PC. If you don't have a MIDI keyboard you can still try out
+ PianoBooster, using the PC keyboard ('x' is middle C), but a MIDI piano
+ is really recommended).
 
 Package: pianobooster-dbg
 Architecture: any
 Section: debug
 Depends: pianobooster (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
-Description: a new way to learn the piano just by playing a game - debug
+Description: learn the piano just by playing a game - debug
  Piano Booster is a new way to learn the piano just by playing a game. 
  It takes elements of the game Guitar Hero but now it uses a real piano
  keyboard and the game has been turned sideways so the notes scroll along

Added: packages/trunk/pianobooster/debian/pianobooster.6
===================================================================
--- packages/trunk/pianobooster/debian/pianobooster.6	                        (rev 0)
+++ packages/trunk/pianobooster/debian/pianobooster.6	2011-11-29 21:28:13 UTC (rev 12886)
@@ -0,0 +1,72 @@
+.\" (c) 2011 Miriam Ruiz <little_miry at yahoo.es>
+.\" 
+.\" This document is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3 of the License, or
+.\" (at your option) any later version.
+.\" 
+.\" This package is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 
+.\" You should have received a copy of the GNU General Public License
+.\" along with this package; if not, write to the Free Software
+.\" Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+.TH "PianoBooster" "6" "" "" ""
+.SH "NAME"
+pianobooster \- learn the piano just by playing a game
+.SH "DESCRIPTION"
+Piano Booster is piano teaching software that can provide piano lessons for beginners as well as for advanced players. It can be used for teaching music theory and is useful for piano practice and learning piano technique. 
+.SH "SYNOPSIS"
+.B pianobooster
+[\fIflags\fR] [\fImidifile\fR]
+.SH "OPTIONS"
+.TP
+\-d
+Increase the debug level
+.TP
+\-q
+Quick start
+.TP
+\-h, \-\-help
+Display a help message
+.TP
+\-v
+Display the version number and exit
+.SH "USAGE"
+Piano Booster is a fun way of playing along with a musical accompaniment and at the same time learning the basics of reading musical notation. The difference between playing along to a CD or a standard midi file is that Piano Booster listens and follows what you are playing on a midi piano keyboard. 
+
+The program has been designed to allow you to play along on a midi piano keyboard with the scrolling notes shown on the screen. The notes you press on the keyboard appear as coloured lines on the musical stave, the colour of which depends whether you have pressed the right or wrong note.
+
+A different musical instrument sound is used for your playing depending whether you are playing the right or wrong notes. This feature also allows Piano Booster to be used with printed sheet music so you can hear if you are playing the right notes while at the same time keeping your eyes on the printed score. The music accompaniment will automatically wait for you to find and play the correct notes in the piece.
+
+Timing markers show whether you are playing ahead or behind of the beat. They appear as white crosses that are drawn over the note.
+.SH "FEATURES"
+- Piano Booster follows you when playing along to a musical accompaniment. If you stop, then so does the music.
+.br
+- Play a single hand and Piano Booster will play the other hand, as well as the rest of instruments, in time with you.
+.br
+- Change the speed of playback to match your playing ability.
+.br
+- Transpose +/- 12 semitones without stopping the play back.
+.br
+- Change the Key Signature of the piece.
+.br
+- Plays any standard midi or kar file.
+.br
+- Play along to any instrument in the midi file.
+.br
+- Adjust the volume of the current part or the volume your piano part.
+.br
+- See how accurate you're playing.
+.br
+- Change the start bar to start playing from any bar in the music. The repeat bars allows you to practice just a few difficult bars continuously.
+.br
+- Timing markers are white crosses that are drawn over each note and show if you are playing ahead or behind the beat.
+.br
+- A different instrument sound is used for the right and wrong notes that you play.
+.SH "SEE ALSO"
+You can find more about the game on its homepage: http://pianobooster.sourceforge.net/
+.SH "AUTHOR"
+The game has been written by Louis J. Barman <louisjb at users.sourceforge.net>. This manual page was written by Miriam Ruiz <little_miry at yahoo.es> for the Debian project.

Added: packages/trunk/pianobooster/debian/pianobooster.manpages
===================================================================
--- packages/trunk/pianobooster/debian/pianobooster.manpages	                        (rev 0)
+++ packages/trunk/pianobooster/debian/pianobooster.manpages	2011-11-29 21:28:13 UTC (rev 12886)
@@ -0,0 +1 @@
+pianobooster.6


