From dd4676ed317fd5f812d81fcc5e3b20fbf4e80328 Mon Sep 17 00:00:00 2001 From: Jack <31696646+myspaghetti@users.noreply.github.com> Date: Tue, 5 May 2020 09:37:39 +0300 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eab1d17..7a48cd5 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,24 @@ ## Push-button installer of macOS on VirtualBox -`macos-guest-virtualbox.sh` is a Bash script that creates a macOS virtual machine guest on VirtualBox with unmodified macOS installation files downloaded directly from Apple servers. + + + + +[`macos-guest-virtualbox.sh`](https://raw.githubusercontent.com/myspaghetti/macos-guest-virtualbox/master/macos-guest-virtualbox.sh) is a Bash script that creates a macOS virtual machine guest on VirtualBox with unmodified macOS installation files downloaded directly from Apple servers. Tested on [Cygwin](https://cygwin.com/install.html). Works on macOS, Windows Subsystem for Linux, and centOS 7. Should work on most modern Linux distros. + + A default install only requires the user to sit patiently and, less than ten times, press enter when prompted by the script, without interacting with the virtual machine. -The script runs without elevated privileges. The macOS guest isn't loaded with extra bootloaders, but it is compatible with [OpenCore](https://github.com/acidanthera/OpenCorePkg/releases). -Tested on [Cygwin](https://cygwin.com/install.html). Works on macOS, Windows Subsystem for Linux, and centOS 7. Should work on most modern Linux distros. + + ### macOS Catalina (10.15), Mojave (10.14), and High Sierra (10.13) currently supported -macOS Catalina version 10.15.2 and higher is only supported by VirtualBox version 6.1.4 and higher. A workaround for lower versions of VirtualBox which involves using earlier versions of `boot.efi` is [described in issue 134](https://github.com/myspaghetti/macos-guest-virtualbox/issues/134#issuecomment-583216307). +The macOS guest isn't loaded with extra bootloaders, but it is compatible with [OpenCore](https://github.com/acidanthera/OpenCorePkg/releases). + + ## Documentation Documentation can be viewed by executing the command `./macos-guest-virtualbox.sh documentation` @@ -28,13 +36,23 @@ The following primary display resolutions are supported by macOS on VirtualBox: ## Unsupported features Developing and maintaining VirtualBox or macOS features is beyond the scope of this script. Some features may behave unexpectedly, such as USB device support, audio support, FileVault boot password prompt support, and other features. -### Performance + + +#### Performance After successfully creating a working macOS virtual machine, consider importing it into QEMU/KVM so it can run with hardware passthrough at near-native performance. QEMU/KVM requires additional configuration that is beyond the scope of the script. -### Audio +#### Bootloaders + +The macOS VirtualBox guest is loaded without extra bootloaders, but it is compatible with [OpenCore](https://github.com/acidanthera/OpenCorePkg/releases). OpenCore requires additional configuration that is beyond the scope of the script. + + + + + +#### Audio macOS may not support any built-in VirtualBox audio controllers. The bootloader [OpenCore](https://github.com/acidanthera/OpenCorePkg/releases) may be able to load open-source audio drivers in VirtualBox, providing the configuration for STAC9221 (Intel HD Audio) or SigmaTel STAC9700,83,84 (ICH AC97) is available. -### FileVault +#### FileVault The VirtualBox EFI implementation does not properly load the FileVault full disk encryption password prompt upon boot. The bootloader [OpenCore](https://github.com/acidanthera/OpenCorePkg/releases/tag/0.5.7) is able to load the password prompt with the parameter `ProvideConsoleGop` set to `true`. See bare [config.plist](https://github.com/myspaghetti/macos-guest-virtualbox/files/4455100/config.plist.txt). ## Dependencies