From b9548fc97c18d98bbc782f0396b5270d019cb791 Mon Sep 17 00:00:00 2001 From: Robert Hargreaves Date: Sat, 7 Sep 2024 23:42:25 +0100 Subject: [PATCH] Add warning about building outside of Docker --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7c07b5..064f432 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# SEGA Mega Drive MIDI Interface +# SEGA Mega Drive MIDI Interface [![Build & Release](https://github.com/rhargreaves/mega-drive-midi-interface/actions/workflows/build.yml/badge.svg)](https://github.com/rhargreaves/mega-drive-midi-interface/actions/workflows/build.yml) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rhargreaves/mega-drive-midi-interface?style=plastic)](https://github.com/rhargreaves/mega-drive-midi-interface/releases) Control the Yamaha YM2612 and PSG of the Sega Mega Drive via MIDI. @@ -59,6 +59,9 @@ You'll need to configure SGDK in your environment accordingly and make changes t make ``` +> [!WARNING] +> Building this project requires certain modifications to be applied to the SGDK. If you are not building using Docker you will need to manually apply patches from the [docker-sgdk](https://github.com/rhargreaves/docker-sgdk) repo (*.patch files in the root) otherwise the build or tests may fail. + ## Contributions Pull requests are welcome, as are donations!