Martchus
/
pianobooster
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

This commit is contained in:
Alexey Loginov 2019-06-21 06:42:38 +03:00
parent 58087828fa
commit cb986f01e3
3 changed files with 31 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
BUILD.md
View File

@ -64,16 +64,3 @@
Or alternatively you can install QtCreator and then open the pianobooster.pro
If you make changes to the source code then please post details.
# 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).

33
README.md
View File

@ -7,9 +7,7 @@ Piano Booster is a MIDI file player that displays the musical notes AND teaches
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/>
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/>
@ -70,6 +68,14 @@ Install RPM, DEB, etc. package.
Packages for Linux are available in repositories of distributions [here](https://pkgs.org/download/pianobooster)
Packages for Linux are available in OBS repository:
[pianobooster](https://software.opensuse.org/download.html?project=home%3Aloginov_alex_valer&package=pianobooster)
[pianobooster-timidity](https://software.opensuse.org/download.html?project=home%3Aloginov_alex_valer&package=pianobooster-timidity)
[pianobooster-fluidsynth](https://software.opensuse.org/download.html?project=home%3Aloginov_alex_valer&package=pianobooster-fluidsynth)
*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.
@ -139,6 +145,8 @@ without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
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).
The Piano Booster Documentation and Music are released under the Creative Commons License (CC-BY).
[PianoBooster License](license.txt)
SOURCE CODE
@ -156,8 +164,23 @@ instructions on how to build the source code.
DEBUGGING
=========
To get a backtrace, build Piano Booster with DEBUG option (type "cmake -DCMAKE_BUILD_TYPE=Debug ."),
type “gdb ./pianobooster”, then “run” then “bt”.
To get a backtrace, build Piano Booster with DEBUG option
type
```cmake -DCMAKE_BUILD_TYPE=Debug .```
type
```gdb ./pianobooster```
then
```run```
then
```bt```
DOCUMENTATION
=============

6
doc/faq.md
View File

@ -12,7 +12,7 @@ Please add to this list if you find any pieces of music that you enjoy playing.
Google search: Taylor's Traditional Tune Book, and download the "English Tunes". They are only single melody to play with quite good MIDI arrangements. Barry is quite fond of key changes which make it quite challenging. Especially "I Saw Three Ships."
[Bach collection](https://www.mutopiaproject.org/cgibin/make-table.cgi?collection=bachgb&preview=1) and others from repository of sheet music [Mutopia Project](https://www.mutopiaproject.org/)
[Bach collection](https://www.mutopiaproject.org/cgibin/make-table.cgi?collection=bachgb&preview=1) and others from repository of sheet music - [Mutopia Project](https://www.mutopiaproject.org/)
[Miracle Piano Tutor](http://piano-booster.2625608.n2.nabble.com/attachment/4582249/0/teachmid.tar.gz)
@ -35,9 +35,9 @@ The general process: write "abc notation" of music (ABC file); convert ABC file
The ABCPlus notation describes the notes to be played by the right and left hands in plain text ascii-character file.
[wiki](http://en.wikipedia.org/wiki/Abc_notation)
[Wiki](http://en.wikipedia.org/wiki/Abc_notation)
[site](http://abcnotation.com/)
[Site](http://abcnotation.com/)
[The ABC Plus Project](http://abcplus.sourceforge.net/)