diff --git a/README.md b/README.md index b637d13..fd9940f 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ https://mgb-waveform-edit.web.app/ -This tool allows one to replace the waveform that is selected in the WAV channel. It sends a custom -SysEx message to mGB, so you will need: +This tool allows one to edit the waveform for [mGB](https://github.com/trash80/mGB). It works via a SysEx message. -1. A custom mGB built from [this branch](https://github.com/tstirrat/mGB/pull/6) +You will need: + +1. A custom mGB - built from [this branch](https://github.com/tstirrat/mGB/pull/6) 1. An ArduinoBoy or some way to send MIDI to the mGB cart I have not tested it in RetroPlug, in theory it should work. @@ -13,5 +14,13 @@ I have not tested it in RetroPlug, in theory it should work. ### Running the development server ``` +bun install bun run dev ``` + +### Building the app + +``` +bun install +bun run build +```