diff --git a/README.md b/README.md index c27c982d3..62a2a028c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -A python program for building and booting OpenCore on legacy Macs, see [Supported SMBIOS](/docs/MODELS.md) on whether your model is supported. +A python program for building and booting OpenCore on legacy Macs, see [Supported SMBIOS](https://dortania.github.io/OpenCore-Legacy-Patcher/MODELS.html) on whether your model is supported. Supported features: @@ -19,64 +19,17 @@ Note: Only clean-installs and upgrades are supported, installs already patched w Note 2: Currently OpenCore Legacy Patcher only supports macOS 11, Big Sur installs. For older OSes, please use [Dosdude1's patchers](http://dosdude1.com) ## How to use +See the online guide on how: -To use, simply: - -1. Ensure your hardware is compatible(See [Supported SMBIOS](/docs/MODELS.md)) -2. [Download and build macOS Installer](./docs/INSTALLER.md) -3. Download the latest release: [OpenCore Legacy Patcher Releases](https://github.com/dortania/Opencore-Legacy-Patcher/releases) -4. Run the `OpenCore-Patcher.app` -5. Run `Build OpenCore`(if building for another machine, please select `Change Model`) - -| First Run | Build EFI | -| :--- | :--- | -| ![](images/first-run.png) | ![](images/build-efi.png) | - - * Note: When the patcher ask you to if you want to use original serials, we recommend doing so. To determine yourself if you want: - * Original: Mac is nearly identical to pre-patcher, with only minor changes in SMBIOS. Ideal configuration for iServices to work correctly - * Custom: Rebuilds SMBIOS table to Mac you're spoofing, generally recommended when troubleshooting such as APFS support missing in the installer - -6. Run `Install OpenCore to USB/internal drive` - -| Select Drive | Select EFI/FAT32 Partition | -| :--- | :--- | -| ![](images/disk-start.png) | ![](images/disk-efi.png) | - - * Ensure you install OpenCore onto a FAT32 partition to ensure your Mac is able to boot it, you may need to format your drive as GUID/GPT in Disk Utility - -7. Reboot machine while holding `Option` to select OpenCore, then boot the macOS Installer - -| Mac Boot Picker | OpenCore Picker | -| :--- | :--- | -| ![](images/efi-boot.png) | ![](images/oc-boot.png) | - -For nightly builds, you can either run `OpenCore-Patcher.command` from [main](https://github.com/dortania/Opencore-Legacy-Patcher/archive/main.zip) or grab the binary from [Github Actions](https://github.com/dortania/Opencore-Legacy-Patcher/actions). Note the latter does not require a py3 install. - -## Post-Installation - -Once finished, see below for common post-installation steps: - -* [Post-Installation](./docs/POST-INSTALL.md) - -## How to uninstall OpenCore? - -To remove OpenCore is actually quite simply: - -1. Remove OpenCore either from the USB or internal drive - * You'll need to mount the drive's EFI partition, and delete the EFI folder - * [See here for example how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) -2. Reset NVRAM - * [Reset NVRAM or PRAM on your Mac](https://support.apple.com/HT204063) - -Know that if you are on Big Sur when you remove the EFI folder, your Mac will no longer boot and show the prohibited symbol. Be ready to install an older version of macOS before you uninstall OpenCore. +* [OpenCore Legacy Patcher Guide](https://dortania.github.io/OpenCore-Legacy-Patcher/) ## Patcher Warnings Since this patcher tricks macOS into thinking you're running a newer Mac, certain functionality may be broken: * Boot Camp Assistant.app - * We recommend running the assistant on a natively supported OS + * We recommend running the assistant on a natively supported OS, running via the patcher may result in unforeseen issues * Legacy Windows Booting * Currently OpenCore cannot boot MBR-based installs, so Ivy Bridge and older Machines may not be able to see Windows in OpenCore's Boot Picker - -## [Troubleshooting](/docs/TROUBLESHOOTING.md) +* Boot Buddy support + * Due to how OpenCore overwrites NVRAM , the usage of Boot Buddy and such tools are **highly** in-advised diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 7bb50277b..e1c2c4250 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -96,6 +96,7 @@ module.exports = { sidebarDepth: 1, children: [ 'TROUBLESHOOTING', + 'UNINSTALL', ] }, diff --git a/docs/UNINSTALL.md b/docs/UNINSTALL.md new file mode 100644 index 000000000..027ee592f --- /dev/null +++ b/docs/UNINSTALL.md @@ -0,0 +1,11 @@ +# Uninstalling OpenCore + +To remove OpenCore is actually quite simply: + +1. Remove OpenCore either from the USB or internal drive + * You'll need to mount the drive's EFI partition, and delete the EFI folder + * [See here for example how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) +2. Reset NVRAM + * [Reset NVRAM or PRAM on your Mac](https://support.apple.com/HT204063) + +Know that if you are on Big Sur when you remove the EFI folder, your Mac will no longer boot and show the prohibited symbol. Be ready to install an older version of macOS before you uninstall OpenCore. \ No newline at end of file