-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added some shields.io badges and some markdown editing on README.md Added some shields.io badges and some markdown editing on README.md, mainly editing markdown. * Update README.md * Update README.md Co-authored-by: Leo <[email protected]> * Update README.md * fixed the downloads badge --------- Co-authored-by: Leo <[email protected]>
- Loading branch information
1 parent
3c01b81
commit 3a722fd
Showing
1 changed file
with
22 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,39 @@ | ||
<h1 align="center">Wasabi</h1> | ||
<p align="center">Wasabi is a modern and fast real-time MIDI player written in Rust.</p> | ||
<p align="center"><img src="/assets/logo.svg" width="256"/></p> | ||
<p align="center">Wasabi is a modern and fast real-time MIDI player written in Rust.</p> | ||
<p align="center"> | ||
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/BlackMIDIDevs/wasabi"> | ||
<img alt="GitHub License" src="https://img.shields.io/github/license/BlackMIDIDevs/wasabi"> | ||
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/BlackMIDIDevs/wasabi"> | ||
<img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/BlackMIDIDevs/wasabi/total"> | ||
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/BlackMIDIDevs/wasabi"> | ||
</p> | ||
|
||
## Features | ||
|
||
- Multithreaded | ||
- Easy to use and configurable | ||
- Integrated MIDI synthesizer (XSynth) | ||
|
||
## Usage | ||
|
||
To use Wasabi, your system must support Vulkan. | ||
|
||
1) Clone the code from this repo | ||
2) Build it and run it | ||
3) Configure wasabi through the settings | ||
4) Select a MIDI by clicking "Open MIDI" | ||
- Clone the code from this repo | ||
- Build it and run it | ||
- Configure wasabi through the settings | ||
- Select a MIDI by clicking `Open MIDI` | ||
|
||
### Keyboard Shortcuts | ||
|
||
- **Space** - Play/Pause MIDI | ||
- **Right Arrow** - Skip 1 second | ||
- **Left Arrow** - Go back 1 second | ||
- **Up Arrow** - Slower note speed | ||
- **Down Arrow** - Faster note speed | ||
- **Alt+Enter** - Toggle fullscreen | ||
- **Ctrl+F** - Show/Hide top panel | ||
- **Ctrl+G** - Show/Hide statistics | ||
- **`Space`** - Play/Pause MIDI | ||
- **`Right Arrow`** - Skip 1 second | ||
- **`Left Arrow`** - Go back 1 second | ||
- **`Up Arrow`** - Slower note speed | ||
- **`Down Arrow`** - Faster note speed | ||
- **`Alt+Enter`** - Toggle fullscreen | ||
- **`Ctrl+F`** - Show/Hide top panel | ||
- **`Ctrl+G`** - Show/Hide statistics | ||
|
||
## License | ||
Wasabi is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text). |