piano/README.md

71 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2020-04-24 14:44:25 +00:00
# ![](images/logos/logo32.png) Piano
Piano is a desktop app that uses built-in MIDI support in order to
offer an usable interface for playing any of the 127 instruments defined
by General MIDI.
## Building
2014-11-08 17:52:36 +00:00
Using Grunt:
```sh
$ npm install
$ grunt build:win # use build:linux or build:mac for other systems
```
Then run the app in `build/win` folder.
## Screenshots
2020-04-24 14:44:25 +00:00
![Main window](images/screenshots/main.png)
*Main window*
2020-04-24 14:44:25 +00:00
![With a music loaded](images/screenshots/music.png)
*With a music loaded*
2020-04-24 14:44:25 +00:00
![Instruments window](images/screenshots/instruments.png)
*Instruments window*
## Known issues
### Pre-release
This app is currently in pre-release state, which means it isn't stable
and that all work you have done might be lost at any time.
If you find any bug or have any improvement idea, please fill an issue.
### Languages
Currently, the app is only available in French. New languages will be
added soon.
### MIDI support
The app won't produce any sound on systems that doesn't have at least one
bundled MIDI output. Maybe should we ship with a default synthetiser.
### Linux/Mac
The app has not yet been tested on Linux and Mac. If you encounter any
problem, please fill an issue.
2014-11-09 12:15:26 +00:00
## Commit convention
:book: Documentation updates
:bug: Bug fixes
:ledger: Rename/move files
:bulb: Features
2014-11-09 18:12:29 +00:00
:lipstick: Fix coding style
2014-11-09 12:15:26 +00:00
## Credits
2014-11-08 17:52:36 +00:00
Icons made by:
- Freepik (http://freepik.com) from http://flaticon.com (CC BY 3.0);
2014-11-09 18:12:29 +00:00
- Icons8 (http://icons8.com) from http://flaticon.com (CC BY 3.0);
2020-04-24 14:44:25 +00:00
- Icomoon (http://icomoon.io) from http://flaticon.com (CC BY 3.0).