diff --git a/README.md b/README.md index 2b14b4a..0774e3e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is a Bash script that creates a VirtualBox guest macOS virtual machine by d The script requires very little user interaction. A default install only requires the user to sit patiently and, less than ten times, press enter when prompted. The script doesn't install any closed-source additions or extra bootloaders. Tested on Cygwin. Works on macOS and WSL, should work on most Linux distros. ### macOS Catalina (10.15), Mojave (10.14), and High Sierra (10.13) currently supported -macOS Catalina 10.15.2 and 10.15.3 require VirtualBox version 6.1.4 or higher. A workaround for lower versions of VirtualBox which involves using earlier versions of `boot.efi` is [described here](https://github.com/myspaghetti/macos-guest-virtualbox/issues/134#issuecomment-583216307). +macOS Catalina 10.15.2 and 10.15.3 require VirtualBox version 6.1.4 or 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). ## Documentation Documentation can be viewed by executing the command `./macos-guest-virtualbox.sh documentation` @@ -25,14 +25,15 @@ Developing and maintaining VirtualBox or macOS features is beyond the scope of t 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 -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. +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 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.6) is able to load the password prompt with the parameter `ProvideConsoleGop` set to `true`. See minimal [config.plist](https://github.com/myspaghetti/macos-guest-virtualbox/files/4302518/config.plist.txt). ## Dependencies -* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)≥6.0 with Extension Pack -* `Bash`≥4.3 (GNU variant; run on Windows through [Cygwin](https://cygwin.com/install.html) or WSL) -* `coreutils` (GNU variant; install through package manager) -* `gzip`, `unzip`, `wget`, `xxd` (install through package manager) -* `dmg2img` (install through package manager on Linux, macOS, or WSL; let the script download it automatically on Cygwin) +All the dependencies should be available through the package manager: `bash` `coreutils` `gzip` `unzip` `wget` `xxd` `dmg2img` `virtualbox` + +* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)≥6.1.4 with Extension Pack, though versions as low as 5.2 may work. +* GNU `Bash`≥4.3, on Windows run through [Cygwin](https://cygwin.com/install.html) or WSL. +* GNU `coreutils`≥8.22, GNU `gzip`≥1.5, Info-ZIP `unzip`≥v6.0, GNU `wget`≥1.14, `xxd`≥1.7 +* `dmg2img`≥1.6.5, on Cygwin the package is not available through the package manager so the script downloads it automatically.