Skip to content

Commit cf81664

Browse files
committed
Update README.md
1 parent b17e6af commit cf81664

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
- A work-in-progress baremetal MIDI synthesizer for the Raspberry Pi 3 or above, based on [Munt], [FluidSynth] and [Circle].
88
- Turn your Raspberry Pi into a dedicated emulation of the [famous multi-timbre sound module][Roland MT-32] used by countless classic MS-DOS, PC-98 and Sharp X68000 games!
9-
- 🆕 Add your favorite [SoundFonts][SoundFont] to expand your synthesizer with [General MIDI], [Roland GS], or even [Yamaha XG] support for endless MIDI possibilities.
10-
- 🆕 Includes General MIDI and Roland GS support out of the box thanks to [GeneralUser GS] by S. Christian Collins.
9+
- Add your favorite [SoundFonts][SoundFont] to expand your synthesizer with [General MIDI], [Roland GS], or even [Yamaha XG] support for endless MIDI possibilities.
10+
- Includes General MIDI and Roland GS support out of the box thanks to [GeneralUser GS] by S. Christian Collins.
1111
- No operating system, no complex Linux audio configuration; just super-low latency audio.
1212
- Easy to configure and ready to play from cold-boot in a matter of seconds.
1313
- The perfect companion for your vintage PC or [MiSTer FPGA] setup.
@@ -20,19 +20,21 @@
2020

2121
- Tested on Raspberry Pi 4 Model B and Raspberry Pi 3 Model A+, B, and B+.
2222
* Pi 2 works, but only with concessions on playback quality.
23-
* Pi 0 and 1 are unfortunately too slow, even with an overclock.
23+
* Pi Zero and 1 are unfortunately too slow (even with an overclock) and unsupported.
2424
- PWM headphone jack audio.
2525
* Quality is known to be poor (aliasing/distortion on quieter sounds).
2626
* It is not currently known whether this can be improved or not.
2727
- [I²S Hi-Fi DAC support][I²S Hi-Fi DACs].
2828
* This is the recommended audio output method for the best quality audio.
29-
- MIDI input via [USB][USB MIDI interfaces] or [GPIO][GPIO MIDI interface] MIDI interfaces.
29+
- MIDI input via [USB][USB MIDI interfaces], [GPIO][GPIO MIDI interface] MIDI interfaces, or the [serial port].
3030
- [Configuration file] for selecting hardware options and fine tuning.
3131
- [LCD status screen support][LCD and OLED displays] (for MT-32 SysEx messages and status information).
3232
- Simple [physical control surface][control surface] using buttons and rotary encoder.
3333
- [MiSTer FPGA integration via user port][MiSTer FPGA user port connection].
3434
- Network MIDI support via [macOS native network MIDI][macOS network MIDI], [rtpMIDI] on Windows, or [rtpmidid] on Linux.
3535
- FTP access to files and auto-update is _planned_.
36+
- A user interface with menu system is _planned_.
37+
- More advanced MIDI routing is _planned_.
3638

3739
## ✨ Quick-start guide
3840

@@ -64,6 +66,14 @@ If you need some help with mt32-pi and the wiki doesn't answer your questions, h
6466

6567
> **Note**: Please don't use the Issues area to ask for help - Issues are intended for reproducible bug reports and feature requests. Thankyou!
6668
69+
## ❤️ Contributing
70+
71+
This project is generally quite stable and very usable, but still considered by its author to be in early stages of development.
72+
73+
Hence, please **DO NOT** work on large features and open pull requests without prior discussion. There is a strong possibility that work-in-progress code for proposed features already exists, but may not yet be public, and your work will have to be rejected.
74+
75+
Trivial changes to the code that fix issues are always welcome, as are improvements to documentation, and hardware/software compatibility reports.
76+
6777
## 🙌 Acknowledgments
6878

6979
- Many thanks go out to @rc55 and @nswaldman for their encouragement and testing! ❤️
@@ -101,6 +111,7 @@ If you need some help with mt32-pi and the wiki doesn't answer your questions, h
101111
[rtpMIDI]: https://www.tobias-erichsen.de/software/rtpmidi/rtpmidi-tutorial.html
102112
[rtpmidid]: https://github.com/davidmoreno/rtpmidid
103113
[SD card preparation]: https://github.com/dwhinham/mt32-pi/wiki/SD-card-preparation
114+
[Serial port]: https://github.com/dwhinham/mt32-pi/wiki/MIDI-via-RS-232-or-USB-to-serial
104115
[SoundFont synthesis]: https://github.com/dwhinham/mt32-pi/wiki/SoundFont-synthesis
105116
[SoundFont]: https://en.wikipedia.org/wiki/SoundFont
106117
[USB MIDI interfaces]: https://github.com/dwhinham/mt32-pi/wiki/USB-MIDI-interfaces

0 commit comments

Comments
 (0)