From 9770ffdad25c0fba1723edeaa60ca826e2ad48fc Mon Sep 17 00:00:00 2001 From: matteo78 Date: Sat, 8 Nov 2014 19:31:42 +0100 Subject: [PATCH] :book: Update README.md Add known issues, screenshots and intro sections --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/README.md b/README.md index 5aad40e..756683e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +

+ ![Piano icon](https://raw.github.com/JacoBits/piano/master/images/logos/logo128.png) +

+ +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. + +[Download latest release](https://github.com/JacoBits/piano/releases) + # Building Using Grunt: @@ -9,6 +19,47 @@ $ grunt build:win # use build:linux or build:mac for other systems Then run the app in `build/win` folder. +# Screenshots + +

+ ![Main window](https://raw.github.com/JacoBits/piano/master/images/screenshots/main.png) + *Main window* +

+ +

+ ![With a music loaded](https://raw.github.com/JacoBits/piano/master/images/screenshots/music.png) + *With a music loaded* +

+ +

+ ![Instruments window](https://raw.github.com/JacoBits/piano/master/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. + # Credits Icons made by: