diff --git a/docs/BUILD.md b/docs/BUILD.md index 870527c84..1d5e989b0 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -2,35 +2,27 @@ Now that we have a macOS installer, lets now build our OpenCore configuration! -First Download the latest release: +If you haven't downloaded OpenCore Patcher yet, do so now: * [OpenCore Legacy Patcher Releases](https://github.com/dortania/Opencore-Legacy-Patcher/releases) Next, run the `OpenCore-Patcher.app`: -![](../images/first-run.png) +![](../images/OCLP-GUI-Main-Menu.png) -From here you have a couple important options: +Here we'll select Build and Install OpenCore and start building: -* Build OpenCore -* Install OpenCore to USB/internal drive -* Change Model -* Patcher Settings - -If you're patching for a different machine than you're running, please select "Change Model" and enter the updated SMBIOS. For more advanced users, you may also tweak the patcher's build settings via "Patcher Settings" - -Now lets enter "Build OpenCore": - -![](../images/build-efi.png) - -The process should be quite quick to build, once finished you'll be plopped back to the main menu. - -Next lets run `Install OpenCore to USB/internal drive`: - -| Select Drive | Select EFI/FAT32 Partition | +| Start Building | Finished Building | | :--- | :--- | -| ![](../images/disk-start.png) | ![](../images/disk-efi.png) | +| ![](../images/OCLP-GUI-Build-Start.png) | ![OCLP GUI Build Finished](../images/OCLP-GUI-Build-Finished.png) | + +Once it finishes building, you'll want to select the Install OpenCore button: + +* If you created a macOS USB manually and don't see it listed, make sure it's either formatted as GUID/GPT or has a FAT32 partition for OpenCore to sit on + + +| Select Drive | Select Partition | +| :--- | :--- | +| ![](../images/OCLP-GUI-EFI-Select-Disk.png) | ![](../images/OCLP-GUI-EFI-Select-Partition.png) | -* If you have issues, please ensure you install OpenCore onto a FAT32 partition to ensure your Mac is able to boot it. You will need to format your drive as GUID/GPT in Disk Utility - # Once finished, head to [Booting OpenCore and macOS](./BOOT.md) diff --git a/docs/INSTALLER.md b/docs/INSTALLER.md index 4abf0b678..fe297e58b 100644 --- a/docs/INSTALLER.md +++ b/docs/INSTALLER.md @@ -7,53 +7,46 @@ This doc is centered around downloading and writing the macOS installer to a USB * Note: 16GB+ USB will be required for the installer -## Downloading +## Creating the installer -The simplest way to download macOS installs would be to use installinstallmacos: +With OpenCore Legacy Patcher, our new GUI includes a download menu for macOS installers. So to start off, you'll want to grab our app: -```sh -[ ! -d ~/macOS-installer/ ] && mkdir ~/macOS-installer; cd ~/macOS-installer; [ ! -f ~/macOS-installer/installinstallmacos.py ] && curl -O https://raw.githubusercontent.com/munki/macadmin-scripts/main/installinstallmacos.py ; sudo python installinstallmacos.py -``` +* [OpenCore Legacy Patcher Release Apps](https://github.com/dortania/OpenCore-Legacy-Patcher/releases) -* Note: On El Capitan (10.11) and older, you'll need to specify a catalog at the end of the command: +For this guide, we'll be using the standard OpenCore-Patcher (GUI). -``` ---catalogurl https://swscan.apple.com/content/catalogs/others/index-11-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog -``` +Once downloaded, open the app and you should be greeted with this menu: -![](../images/munki.png) +![OCLP GUI Main Menu](../images/OCLP-GUI-Main-Menu.png) -As you can see, we get a nice list of macOS installers. If you need a particular versions of macOS, you can select it by typing the number next to it. For this example we'll choose 10: +First we'll want to select the "Create macOS Installer" button. This will present you with 2 options: -![](../images/munki-process.png) +![](../images/OCLP-GUI-Create-Installer-Menu.png) -This is going to take a while as we're downloading the entire 12GB+ macOS installer. +For this example, we'll assume you'll need an installer. Selecting this option will download Apple's Installer Catalogs and build a list for you to choose: -Once finished, you'll find in your `~/macOS-Installer/` folder a DMG containing the macOS Installer, called `Install_macOS_11.1-20C69.dmg` for example. Mount it and you'll find the installer application. -* Note: We recommend to move the Install macOS.app into the `/Applications` folder, as we'll be executing commands from there. -* Note 2: Running Cmd+Shift+G in Finder will allow you to easily jump to `~/macOS-installer` +| Downloading | Listed Installers | +| :--- | :--- | +| ![OCLP GUI Installer Download Catalog](../images/OCLP-GUI-Installer-Download-Catalog.png) | ![OCLP GUI Installer Download Listed Products](../images/OCLP-GUI-Installer-Download-Listed-Products.png) | -![](../images/munki-done-2.png) +Since the patcher officially supports Big Sur and newer for patching, only those entires will be showen. For ourselves, we'll select 12.1 as that's the latest public release at the time of writing. This will download and install the macOS installer to your applications folder. -![](../images/munki-dmg.png) +| Downloading the Installer | Requesting to install | Finished Installing | +| :--- | :--- | :--- | +| ![OCLP GUI Installer Download Progress](../images/OCLP-GUI-Installer-Download-Progress.png) | ![OCLP GUI Installer Needs Installing](../images/OCLP-GUI-Installer-Needs-Installing.png) | ![OCLP GUI Installer Download Finished](../images/OCLP-GUI-Installer-Download-Finished.png) | -## Building +Once finished, you can proceed to write the installer onto a USB drive. -Now we'll be formatting the USB to prep for both the macOS installer and OpenCore. We'll want to use macOS Extended (HFS+) with a GUID partition map(Using GUID is important for the patcher). This will create two partitions: the main `MyVolume` and a second called `EFI` which is used as a boot partition where your Mac's firmware will check for boot files. `EFI` partitions will be hidden by default, so don't worry if you don't immediately see them. +* Note: The entire USB drive will be formatted -* Note: By default, Disk Utility only shows partitions – press Cmd/Win+2 to show all devices (alternatively you can press the View button) +| Select Downloaded Installer | Select disk to format | +| :--- | :--- | +| ![](../images/OCLP-GUI-Installer-Select-Local-Installer.png) | ![](../images/OCLP-GUI-Installer-Format-USB.png) | -![Formatting the USB](../images/format-usb.png) - -Next run the `createinstallmedia` command provided by [Apple](https://support.apple.com/en-us/HT201372). Note that the command is made for USB's formatted with the name `MyVolume`: - -```sh -sudo /Applications/Install\ macOS\ Big\ Sur.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume -``` - -* Note: You can also replace the `createinstallmedia` path with that of where your installer's located (same idea with the drive name). - -![](../images/createinstallmedia.png) +Now the patcher will start the installer flashing! +| Flashing | Success Prompt | Finished Flashing | +| :--- | :--- | +| ![](../images/OCLP-GUI-Installer-Flashing-Process.png) | ![](../images/OCLP-GUI-Installer-Sucess-Prompt.png) | ![](../images/OCLP-GUI-Installer-Finished-Script.png) | # Once finished, head to [Building and installing OpenCore](./BUILD.md) diff --git a/images/OCLP-GUI-Build-Finished.png b/images/OCLP-GUI-Build-Finished.png new file mode 100644 index 000000000..2cdad3cbc Binary files /dev/null and b/images/OCLP-GUI-Build-Finished.png differ diff --git a/images/OCLP-GUI-Build-Start.png b/images/OCLP-GUI-Build-Start.png new file mode 100644 index 000000000..ec94d3eef Binary files /dev/null and b/images/OCLP-GUI-Build-Start.png differ diff --git a/images/OCLP-GUI-Create-Installer-Menu.png b/images/OCLP-GUI-Create-Installer-Menu.png new file mode 100644 index 000000000..a61a94972 Binary files /dev/null and b/images/OCLP-GUI-Create-Installer-Menu.png differ diff --git a/images/OCLP-GUI-EFI-Finished-Install.png b/images/OCLP-GUI-EFI-Finished-Install.png new file mode 100644 index 000000000..c401b8dee Binary files /dev/null and b/images/OCLP-GUI-EFI-Finished-Install.png differ diff --git a/images/OCLP-GUI-EFI-Needs-Permission.png b/images/OCLP-GUI-EFI-Needs-Permission.png new file mode 100644 index 000000000..3e9a5c1ad Binary files /dev/null and b/images/OCLP-GUI-EFI-Needs-Permission.png differ diff --git a/images/OCLP-GUI-EFI-Select-Disk.png b/images/OCLP-GUI-EFI-Select-Disk.png new file mode 100644 index 000000000..ffa10252d Binary files /dev/null and b/images/OCLP-GUI-EFI-Select-Disk.png differ diff --git a/images/OCLP-GUI-EFI-Select-Partition.png b/images/OCLP-GUI-EFI-Select-Partition.png new file mode 100644 index 000000000..5c5823d66 Binary files /dev/null and b/images/OCLP-GUI-EFI-Select-Partition.png differ diff --git a/images/OCLP-GUI-Installer-Download-Catalog.png b/images/OCLP-GUI-Installer-Download-Catalog.png new file mode 100644 index 000000000..afd34417e Binary files /dev/null and b/images/OCLP-GUI-Installer-Download-Catalog.png differ diff --git a/images/OCLP-GUI-Installer-Download-Finished.png b/images/OCLP-GUI-Installer-Download-Finished.png new file mode 100644 index 000000000..507dab563 Binary files /dev/null and b/images/OCLP-GUI-Installer-Download-Finished.png differ diff --git a/images/OCLP-GUI-Installer-Download-Listed-Products.png b/images/OCLP-GUI-Installer-Download-Listed-Products.png new file mode 100644 index 000000000..36420570d Binary files /dev/null and b/images/OCLP-GUI-Installer-Download-Listed-Products.png differ diff --git a/images/OCLP-GUI-Installer-Download-Progress.png b/images/OCLP-GUI-Installer-Download-Progress.png new file mode 100644 index 000000000..f7d9da278 Binary files /dev/null and b/images/OCLP-GUI-Installer-Download-Progress.png differ diff --git a/images/OCLP-GUI-Installer-Finished-Script.png b/images/OCLP-GUI-Installer-Finished-Script.png new file mode 100644 index 000000000..c03550e19 Binary files /dev/null and b/images/OCLP-GUI-Installer-Finished-Script.png differ diff --git a/images/OCLP-GUI-Installer-Flashing-Process.png b/images/OCLP-GUI-Installer-Flashing-Process.png new file mode 100644 index 000000000..f4c06e3c4 Binary files /dev/null and b/images/OCLP-GUI-Installer-Flashing-Process.png differ diff --git a/images/OCLP-GUI-Installer-Format-USB.png b/images/OCLP-GUI-Installer-Format-USB.png new file mode 100644 index 000000000..6ef086c34 Binary files /dev/null and b/images/OCLP-GUI-Installer-Format-USB.png differ diff --git a/images/OCLP-GUI-Installer-Needs-Installing.png b/images/OCLP-GUI-Installer-Needs-Installing.png new file mode 100644 index 000000000..7f30f085d Binary files /dev/null and b/images/OCLP-GUI-Installer-Needs-Installing.png differ diff --git a/images/OCLP-GUI-Installer-Select-Local-Installer.png b/images/OCLP-GUI-Installer-Select-Local-Installer.png new file mode 100644 index 000000000..80eca9214 Binary files /dev/null and b/images/OCLP-GUI-Installer-Select-Local-Installer.png differ diff --git a/images/OCLP-GUI-Installer-Sucess-Prompt.png b/images/OCLP-GUI-Installer-Sucess-Prompt.png new file mode 100644 index 000000000..2166e9212 Binary files /dev/null and b/images/OCLP-GUI-Installer-Sucess-Prompt.png differ diff --git a/images/OCLP-GUI-Main-Menu.png b/images/OCLP-GUI-Main-Menu.png new file mode 100644 index 000000000..34c86f49f Binary files /dev/null and b/images/OCLP-GUI-Main-Menu.png differ