documentation

macos-guest-virtualbox.sh

@@ -2,7 +2,7 @@
 # Push-button installer of macOS on VirtualBox
 # (c) myspaghetti, licensed under GPL2.0 or higher
 # url: https://github.com/myspaghetti/macos-guest-virtualbox
-# version 0.90.8
+# version 0.90.9
 
 # Dependencies: bash  coreutils  gzip  unzip  wget  xxd  dmg2img
 # Supported versions:
@@ -765,7 +765,10 @@ if [[ -n $(
 ) ]]; then
     echo "Could not attach \"${macOS_release_name}_Installation_files.viso\". Exiting."; exit
 fi
-echo "Starting virtual machine ${vm_name}. This should take a couple of minutes."
+echo "Starting virtual machine \"${vm_name}\".
+This should take a couple of minutes. If booting fails, check that VirtualBox
+uses the VT-x/AMD-V paravirtualization interface, or see the documentation for
+information on applying different CPU profiles."
 ( VBoxManage startvm "${vm_name}" >/dev/null 2>&1 )
 echo "While the script is running, please do not interact with the virtual machine."
 [[ -z "${kscd}" ]] && declare_scancode_dict
@@ -1096,6 +1099,15 @@ ${low_contrast_color}5120x2880  2880x1800  2560x1600  2560x1440  1920x1200  1600
   ${low_contrast_color}1440x900   1280x800   1024x768   640x480${default_color}
 Secondary displays can have an arbitrary resolution.
 
+        ${highlight_color}CPU profiles${default_color}
+macOS does not supprort every CPU supported by VirtualBox. If the macOS Base
+System does not boot, try applying different CPU profiles to the virtual
+machine with the following command:
+    ${low_contrast_color}VBoxManage modifyvm \"\${vm_name} --cpu-profile \"\${cpu_profile}\"${default_color}
+Available CPU profiles:
+  ${low_contrast_color}\"Intel Xeon X5482 3.20GHz\"  \"Intel Core i7-2635QM\"  \"Intel Core i7-3960X\"${default_color}
+  ${low_contrast_color}\"Intel Core i5-3570\"  \"Intel Core i7-5600U\"  \"Intel Core i7-6700K\"${default_color}
+
         ${highlight_color}Unsupported features${default_color}
 Developing and maintaining VirtualBox or macOS features is beyond the scope of
 this script. Some features may behave unexpectedly, such as USB device support,