update docs
This commit is contained in:
-
parent
e0ee5dcaa3
commit
249b76a472
14
BUILD.md
14
BUILD.md
|
|
@ -4,7 +4,7 @@
|
|||
'build-essential" are installed.
|
||||
|
||||
Then type "cmake .", followed by "make". Finally as root type "make install".
|
||||
(The pianobooster binary executable is now the "build" subdirectory)
|
||||
(The pianobooster binary executable is now in the "build" subdirectory.)
|
||||
|
||||
To build a debug version create a dir called "debug" and change to that dir and then
|
||||
type "cmake -DCMAKE_BUILD_TYPE=Debug .."
|
||||
|
|
@ -13,11 +13,13 @@
|
|||
|
||||
See [Debian branch](https://github.com/captnfab/PianoBooster/tree/debian) for more details.
|
||||
|
||||
See [Mageia Linux spec file ](pianobooster.spec) for more details.
|
||||
|
||||
If you make changes to the source code then please post details.
|
||||
|
||||
# macOS
|
||||
|
||||
Install latest Xcode (from Apple Developer Connection, free registration required)
|
||||
Install latest Xcode (from Apple Developer Connection, free registration required).
|
||||
|
||||
Install CMake and QT libraries via Homebrew:
|
||||
|
||||
|
|
@ -32,14 +34,12 @@
|
|||
```
|
||||
|
||||
Open the project file in XCode, set whatever options you like (universal or single architecture,
|
||||
debug or release etc.) and compile
|
||||
debug or release etc.) and compile.
|
||||
|
||||
To make a self contained application bundle use QT's macdeployqt tool (included in QT 4.5.0)
|
||||
To make a self contained application bundle use QT's macdeployqt tool (included in QT 4.5.0).
|
||||
|
||||
If you make changes to the source code then please post details.
|
||||
|
||||
See also [README-macOS.md](README-macOS.md)
|
||||
|
||||
# Windows
|
||||
|
||||
To compile in Windows install the Open Source version of Qt and CMake and optionally Geany.
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
|
||||
Once this is completed type "make".
|
||||
|
||||
Or alternatively you can install QtCreator and then open the painobooster.pro
|
||||
Or alternatively you can install QtCreator and then open the pianobooster.pro
|
||||
|
||||
If you make changes to the source code then please post details.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,63 +0,0 @@
|
|||
# Introduction
|
||||
|
||||
Piano Booster is a MIDI file player that displays the musical notes AND teaches you how to
|
||||
play the piano. You can play along to any track in the midi file and PianoBooster will
|
||||
follow YOUR playing. PianoBooster makes sight reading fun!
|
||||
|
||||
Piano Booster is a free (Open Source) program available from:
|
||||
|
||||
<https://github.com/captnfab/PianoBooster/>
|
||||
|
||||
Original work by Louis J. Barman can be found here: <http://pianobooster.sourceforge.net/>
|
||||
|
||||
# Requirements
|
||||
|
||||
To run Piano Booster you need a MIDI Piano Keyboard and a MIDI-USB interface if the keyboard
|
||||
does not have a USB interface. (If you don't have a MIDI keyboard you can still try out
|
||||
PianoBooster using the computer's keyboard, 'x' is middle C).
|
||||
|
||||
To hear music from the computer you will need a General Midi compatible sound synthesizer.
|
||||
While there are many possible choices for the Mac (Timidity, FluidSynth or an external MIDI
|
||||
Synth), the easiest way is to use SimplSynth, which can be obtained for free (MIT license)
|
||||
from: <http://notahat.com/simplesynth>
|
||||
|
||||
This must be started before Pianobooster, and also allows to load custom Soundfonts.
|
||||
|
||||
# MIDI files
|
||||
|
||||
To run PianoBooster you will need some Midi files preferably with right and left piano
|
||||
parts on channels 4 and 3. Some high quality demo MIDI files that are compatible with
|
||||
PianoBooster are available in doc/courses/*/ directories.
|
||||
|
||||
# Instructions
|
||||
|
||||
Double Click on the DMG file containing PianoBooster, then just drag the pianobooster.app
|
||||
file wherever you wish (/Application folder is suggested).
|
||||
|
||||
Once the Piano Booster application starts up you must first setup the midi input and midi
|
||||
output interface from the Setup menu. Next open a midi file ".mid" or a karaoke ".kar" file
|
||||
using File/Open from the Piano Booster menu. Now choose the skill level, if you want to
|
||||
just listen to the midi music -- select 'listen', to play along with a midi keyboard with
|
||||
the music following your playing -- select 'follow you'. Finally click on the Play icon to
|
||||
start.
|
||||
|
||||
It is recommended that you shut down all other programs whilst running Piano Booster so that
|
||||
the scrolling notes move smoothly across the screen.
|
||||
|
||||
# License
|
||||
|
||||
Piano Booster is fully copyrighted by the author and all rights are reserved.
|
||||
|
||||
PianoBooster is free software (Open Source 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.
|
||||
|
||||
PianoBooster 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 in the file "gplv3.txt" or from the web site
|
||||
<http://www.gnu.org/licenses/> or [gplv3.txt](gplv3.txt).
|
||||
|
||||
# Source code
|
||||
|
||||
As part of GNU General Public License the source code for PianoBooster is available from
|
||||
the GitHub site <https://github.com/captnfab/PianoBooster>.
|
||||
83
README.md
83
README.md
|
|
@ -5,7 +5,7 @@ INTRODUCTION
|
|||
|
||||
Piano Booster is a MIDI file player that displays the musical notes AND teaches you how to
|
||||
play the piano. You can play along to any track in the midi file and PianoBooster will
|
||||
follow YOUR playing. PianoBooster makes sight reading fun!
|
||||
follow YOUR playing. PianoBooster makes sight reading fun!
|
||||
|
||||
Piano Booster is a free (Open Source) program available from:
|
||||
|
||||
|
|
@ -15,18 +15,68 @@ Original work by Louis J. Barman can be found here: <http://pianobooster.sourcef
|
|||
|
||||
A huge thanks to him and to all the contributers.
|
||||
|
||||
REQUIREMENTS
|
||||
============
|
||||
WINDOWS
|
||||
=======
|
||||
|
||||
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 recommend).
|
||||
middle C - but a MIDI piano is recommend).
|
||||
|
||||
To hear the music you will need a General Midi compatible sound synthesizer. Unfortunately
|
||||
the "Microsoft GS Wavetable software synthesizer" that comes with Windows XP introduces an
|
||||
unacceptable delay (latency) between pressing a note and hearing the sound. For this reason
|
||||
the use of "Microsoft GS Wavetable software synthesizer" is not recommend. Please see the
|
||||
forum section of the PianoBooster website for possible solutions.
|
||||
forum for possible solutions.
|
||||
|
||||
Double Click on the EXE file of Windows installer for installation.
|
||||
|
||||
[PianoBoosterInstall-0-6-4.exe](https://sourceforge.net/projects/pianobooster/files/pianobooster/0.6.4/PianoBoosterInstall-0-6-4.exe/download) (obsoleted)
|
||||
|
||||
macOS
|
||||
=====
|
||||
|
||||
To run Piano Booster you need a MIDI Piano Keyboard and a MIDI-USB interface if the keyboard
|
||||
does not have a USB interface. (If you don't have a MIDI keyboard you can still try out
|
||||
PianoBooster using the computer's keyboard, 'x' is middle C).
|
||||
|
||||
To hear music from the computer you will need a General Midi compatible sound synthesizer.
|
||||
While there are many possible choices for the Mac (Timidity, FluidSynth or an external MIDI
|
||||
Synth), the easiest way is to use SimpleSynth, which can be obtained for free (MIT license)
|
||||
from: <http://notahat.com/simplesynth>
|
||||
|
||||
This must be started before Pianobooster, and also allows to load custom Soundfonts.
|
||||
|
||||
Double Click on the DMG file containing PianoBooster, then just drag the pianobooster.app
|
||||
file wherever you wish (/Application folder is suggested).
|
||||
|
||||
[pianobooster-mac-0.6.2.dmg](https://sourceforge.net/projects/pianobooster/files/pianobooster/0.6.2/pianobooster-mac-0.6.2.dmg/download) (obsoleted)
|
||||
|
||||
[pianobooster-mac-0.6.5-alpha1.dmg](https://github.com/chrisballinger/PianoBooster/releases/tag/v0.6.5-alpha1) (not official)
|
||||
|
||||
LINUX
|
||||
=====
|
||||
|
||||
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 recommend).
|
||||
|
||||
To hear music from the computer you will need a General Midi compatible sound synthesizer.
|
||||
While there are many possible choices for the Linux (Timidity, FluidSynth), the easiest way is
|
||||
to use Timidity.
|
||||
|
||||
This must be started before Pianobooster, and also allows to load custom Soundfonts.
|
||||
|
||||
Install RPM, DEB, etc. package.
|
||||
|
||||
Packages for Linux are available in repositories of distributions [here](https://pkgs.org/download/pianobooster)
|
||||
|
||||
*Note:* In Ubuntu 9.04 there is an issue with the Intel drivers which that means PianoBooster
|
||||
performs very badly if you have Intel graphic chips. Upgrading to Ubuntu 9.10 fixes this problem.
|
||||
|
||||
*Note:* The packages provided with distributions may not exist or are out of date,
|
||||
in which case you will have to compile from the source code.
|
||||
However compiling from source is quite easy on Linux, see the instructions
|
||||
in the section below.
|
||||
|
||||
MIDI FILES
|
||||
==========
|
||||
|
|
@ -41,11 +91,11 @@ INSTRUCTIONS
|
|||
Once the Piano Booster application starts up you must first setup the midi input and midi
|
||||
output interface from the Setup menu. Next open a midi file ".mid" or a karaoke ".kar" file
|
||||
using File/Open from the Piano Booster menu. Now choose the skill level, if you want to
|
||||
just listen to the midi music -- select 'listen', to play along with a midi keyboard with
|
||||
the music following your playing -- select 'follow you'. Finally click on the Play icon to
|
||||
just listen to the midi music - select 'listen', to play along with a midi keyboard with
|
||||
the music following your playing - select 'follow you'. Finally click on the Play icon to
|
||||
start.
|
||||
|
||||
It is recommended that you shut down all other programs whilst running Piano Booster so that
|
||||
It is recommended that you shut down all other programs while running Piano Booster so that
|
||||
the scrolling notes move smoothly across the screen.
|
||||
|
||||
TRANSLATIONS
|
||||
|
|
@ -61,15 +111,15 @@ You can translate by [Pull Request](https://github.com/captnfab/PianoBooster/pul
|
|||
|
||||
You need to translate:
|
||||
|
||||
[Main program](https://github.com/captnfab/PianoBooster/blob/master/translations/pianobooster_blank.ts)
|
||||
[Main program](translations/pianobooster_blank.ts)
|
||||
|
||||
[Courses](https://github.com/captnfab/PianoBooster/blob/master/translations/music_blank.ts)
|
||||
[Courses](translations/music_blank.ts)
|
||||
|
||||
[Desktop file #1](https://github.com/captnfab/PianoBooster/blob/master/pianobooster.desktop)
|
||||
[Desktop file #1](pianobooster.desktop)
|
||||
|
||||
[Desktop file #2](https://github.com/captnfab/PianoBooster/blob/master/tools/timidity/pianobooster-timidity.desktop)
|
||||
[Desktop file #2](tools/timidity/pianobooster-timidity.desktop)
|
||||
|
||||
[Desktop file #3](https://github.com/captnfab/PianoBooster/blob/master/tools/fluidsynth/pianobooster-fluidsynth.desktop)
|
||||
[Desktop file #3](tools/fluidsynth/pianobooster-fluidsynth.desktop)
|
||||
|
||||
LICENSE
|
||||
=======
|
||||
|
|
@ -90,6 +140,11 @@ See the GNU General Public License in the file "gplv3.txt" or from the web site
|
|||
SOURCE CODE
|
||||
===========
|
||||
|
||||
Download and uncompress the archive file below and then follow the instructions in
|
||||
the *BUILD.md* file.
|
||||
|
||||
[PianoBooster releases](https://github.com/captnfab/PianoBooster/releases)
|
||||
|
||||
As part of GNU General Public License the source code for PianoBooster is available from
|
||||
the GitHub site <https://github.com/captnfab/PianoBooster>. See the [BUILD.md](BUILD.md) for
|
||||
instructions on how to build the source code.
|
||||
|
|
@ -113,7 +168,7 @@ PianoBooster is community developing project since 2018. You're welcome with pat
|
|||
|
||||
[Pull Requests](https://github.com/captnfab/PianoBooster/pulls)
|
||||
|
||||
We have many issues always [Issues](https://github.com/captnfab/PianoBooster/issues)
|
||||
We have many [issues](https://github.com/captnfab/PianoBooster/issues) always.
|
||||
|
||||
We are looking for musicians to make music for pianobooster. It can be educational courses or other melodies: [music sources](music/src). For more information look at [README.md](doc/courses/README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ v0.7.0:
|
|||
- Fix problem loading midi files with text events
|
||||
- New Windows installer
|
||||
- Use hicolor icon theme
|
||||
- Fix USE_FLUIDSYNTH
|
||||
|
||||
v0.6.6: (05 September 2013)
|
||||
- Reset should be fixed now (keylights)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
|
||||
|
||||
# Boost your Piano playing skills
|
||||
|
||||
- [Presentation](#presentation)
|
||||
|
|
@ -10,7 +9,6 @@
|
|||
- [Features](#features)
|
||||
- [Screenshots](#screenshots)
|
||||
- [FAQ](faq.md)
|
||||
- [Download](download.md)
|
||||
- [Hints on playing the Piano](pianohints.md)
|
||||
- [Piano Booster Music](courses/README.md)
|
||||
|
||||
|
|
@ -28,6 +26,7 @@ between playing along to a CD or a standard midi file is that *PianoBooster*
|
|||
listens and follows what you are playing on a midi piano keyboard.
|
||||
|
||||
### Introduction
|
||||
|
||||
*PianoBooster* is a free (Open Source) program that plays Standard Midi Files
|
||||
and allows you to change the speed of playback
|
||||
and transpose the music etc.
|
||||
|
|
@ -52,7 +51,6 @@ 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.
|
||||
|
||||
|
||||
### PianoBooster in Action
|
||||
|
||||
Watch the video and see the features of *PianoBooster* in action.
|
||||
|
|
@ -60,7 +58,11 @@ Watch the video and see the features of *PianoBooster* in action.
|
|||
[](http://www.youtube.com/watch?v=UGbfm8Tv-20)
|
||||
|
||||
More videos are available [here](https://www.youtube.com/watch?v=7YaDllVreuM) and [here](https://www.youtube.com/watch?v=58iw8nu3EOM)
|
||||
[](http://www.youtube.com/watch?v=7YaDllVreuM)
|
||||
|
||||
[](http://www.youtube.com/watch?v=58iw8nu3EOM)
|
||||
|
||||
*Piano Booster* is piano teaching software that can provide piano lessons for
|
||||
beginners as well as for advanced players.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ These pieces of music have been created to work with _PianoBooster_ and
|
|||
are free from copyright or have the creative commons copyright.
|
||||
All the music is available [here](https://github.com/captnfab/PianoBooster/raw/master/music/BoosterMusicBooks.zip).
|
||||
|
||||
_Please add to the music on this page -- everyone can help._ For more information see this
|
||||
_Please add to the music on this page - everyone can help._ For more information see this
|
||||
[forum post](http://piano-booster.2625608.n2.nabble.com/Creating-music-for-PianoBooster-using-MMA-Everyone-can-help-td4167350.html).
|
||||
The piano parts for were created using the [ABC Plus music](http://abcplus.sourceforge.net/) system,
|
||||
and the accompaniment was created with the [Musical MIDI Accompaniment (MMA)](http://www.mellowood.ca/mma/).
|
||||
|
|
|
|||
|
|
@ -1,65 +0,0 @@
|
|||
# Download PianoBooster
|
||||
|
||||
## Requirements
|
||||
|
||||
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 recommend).
|
||||
|
||||
To hear the music you will need a General Midi compatible sound synthesizer. Unfortunately
|
||||
the "Microsoft GS Wavetable software synthesizer" that comes with Windows introduces an
|
||||
unacceptable delay (latency) between pressing a note and hearing the sound. For this reason
|
||||
the use of "Microsoft GS Wavetable software synthesizer" is not recommend. Please see the
|
||||
forum section for possible solutions.
|
||||
|
||||
## MIDI files
|
||||
|
||||
To run PianoBooster you will need some Midi files preferably with right and left piano parts on channels 4 and 3.
|
||||
Some high quality demo MIDI files that are compatible with
|
||||
PianoBooster are available in doc/courses/*/ directories.
|
||||
|
||||
## Executable for Windows
|
||||
|
||||
There is now an installer/uninstaller for windows. Just download and run this setup program.
|
||||
|
||||
[PianoBoosterInstall-0-6-4.exe](https://sourceforge.net/projects/pianobooster/files/pianobooster/0.6.4/PianoBoosterInstall-0-6-4.exe/download) (obsoleted)
|
||||
|
||||
## Executable for The Mac
|
||||
|
||||
Piano Booster has been tested with [SimpleSynth](http://notahat.com/simplesynth)
|
||||
for the Mac which can be obtained for free (MIT license).
|
||||
|
||||
Version 0.6.4 for the Mac is coming soon in the meantime here is the previous release.
|
||||
A universal binary for the Mac (Thanks to Christian).
|
||||
|
||||
[pianobooster-mac-0.6.2.dmg](https://sourceforge.net/projects/pianobooster/files/pianobooster/0.6.2/pianobooster-mac-0.6.2.dmg/download) (obsoleted)
|
||||
|
||||
[pianobooster-mac-0.6.5-alpha1.dmg](https://github.com/chrisballinger/PianoBooster/releases/tag/v0.6.5-alpha1) (not official)
|
||||
|
||||
## Packages for Linux
|
||||
|
||||
Packages for Linux are available in repositories of distributions [here](https://pkgs.org/download/pianobooster)
|
||||
|
||||
*Note:* In Ubuntu 9.04 there is an issue with the Intel drivers which that means PianoBooster
|
||||
performs very badly if you have Intel graphic chips. Upgrading to Ubuntu 9.10 fixes this problem.
|
||||
|
||||
*Note:* The packages provided with distributions may not exist or are out of date,
|
||||
in which case you will have to compile from the source code.
|
||||
However compiling from source is quite easy on Linux, see the instructions
|
||||
in the section below.
|
||||
|
||||
## Source Code for all platforms
|
||||
|
||||
Download and uncompress the archive file below and then follow the instructions in
|
||||
the *BUILD.md* file.
|
||||
|
||||
[PianoBooster releases](https://github.com/captnfab/PianoBooster/releases)
|
||||
|
||||
*Compiling on Linux:* You need to have the following packages installed *cmake*,
|
||||
*libqt5-dev*, *libasound2-dev*, and the *build-essential* packages. Then in the
|
||||
*pianobooster/build* directory type `cmake ../src`, then type `make`, followed
|
||||
by `sudo make install`. Finally type `sudo update-desktop-database` to get *open
|
||||
with* working in Nautilus. (Version 0.6.4b fixes a problem on Ubutnu 10.4 Lucid
|
||||
Lynx).
|
||||
|
||||
*Compiling on Windows:* The easiest way to compile on windows download and run LGPL / Free version of *Qt SDK: Complete Development Environment*.
|
||||
|
|
@ -50,7 +50,7 @@ Using 'fluidsynth': [wrapper script and desktop file](https://github.com/captnfa
|
|||
|
||||
While there are many possible choices General Midi sound generators for the Mac
|
||||
(Timidity, FluidSynth or an external MIDI Synth), the easiest way is to use
|
||||
SimplSynth, which can be obtained for free (MIT license) frome [here](http://notahat.com/simplesynth)
|
||||
SimpleSynth, which can be obtained for free (MIT license) frome [here](http://notahat.com/simplesynth)
|
||||
|
||||
This must be started before Pianobooster, and also allows to load custom Soundfonts.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ These pieces of music have been created to work with _PianoBooster_ and
|
|||
are free from copyright or have the creative commons copyright.
|
||||
All the music is available [here](https://github.com/captnfab/PianoBooster/raw/master/music/BoosterMusicBooks.zip).
|
||||
|
||||
_Please add to the music on this page -- everyone can help._ For more information see this
|
||||
_Please add to the music on this page - everyone can help._ For more information see this
|
||||
[forum post](http://piano-booster.2625608.n2.nabble.com/Creating-music-for-PianoBooster-using-MMA-Everyone-can-help-td4167350.html).
|
||||
The piano parts for were created using the [ABC Plus music](http://abcplus.sourceforge.net/) system,
|
||||
and the accompaniment was created with the [Musical MIDI Accompaniment (MMA)](http://www.mellowood.ca/mma/).
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ then
|
|||
fi
|
||||
|
||||
fluidsynth -s -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 $sf2_1 $sf2_2 &
|
||||
sleep 1
|
||||
PID=$!
|
||||
sleep 1
|
||||
pianobooster
|
||||
kill $PID
|
||||
|
|
|
|||
Loading…
Reference in New Issue