diff --git a/docs/UPDATE.md b/docs/UPDATE.md index 2319205e3..e458b2fe6 100644 --- a/docs/UPDATE.md +++ b/docs/UPDATE.md @@ -1,21 +1,13 @@ -# Updating OpenCore and Patches +# Updating This guide explains how to get fully up to date application, bootloader and patches. -## Updating the application +## Updating the application, OpenCore and patches Latest versions of OCLP can download updates by themselves, you will get notified of a new update with the changelog. [You can also manually download the latest release here.](https://github.com/dortania/OpenCore-Legacy-Patcher/releases) - -
- Update Avaialble -
- - -## Updating patches - After the update, the application asks if you want to update OpenCore and root patches. If you do not need to change any settings, you can click "Yes" and follow the procedure. If you want to change settings, select "No" from here and do your settings, then manually build and install OpenCore to update to the latest version of the bootloader. @@ -23,13 +15,14 @@ If you do not need to change any settings, you can click "Yes" and follow the pr Finally install new root patches to ensure you're running on the latest fixes for on-disk patches. -
- Update Successful -
+| Update available | Update successful | +| :--- | :--- | +| Update Available | Update Successful | -## Checking OCLP and OpenCore versions -To check what version of OpenCore bootloader and the Patcher you're currently running, you can run the following in the terminal: +#### Checking OCLP and OpenCore versions + +To check what version of OpenCore bootloader and the Patcher you're currently running, open the OCLP application and navigate to `Settings -> App` and look for "Booted Information". Alternatively you can check the version from Terminal using the following commands. ```bash # OpenCore Version @@ -38,8 +31,43 @@ nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:opencore-version nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:OCLP-Version ``` -
- OCLP version -
-From this, we can see that we're running a RELEASE version of OpenCore 0.9.0 built on January 1st, 2023 with Patcher Version 0.6.0! +| Version in app | Version in Terminal | +| :--- | :--- | +| Build start | OCLP version | + + +## Preparing OCLP for macOS update + +It is usually recommended to be on the latest OCLP version for macOS updates. This part details how to prepare OCLP for latest update. + +### Major upgrades + +This part is for major upgrades, such as `Sonoma (14)` -> `Sequoia (15)` + +1. Make sure the OCLP app is up to date. +2. After app has updated, rebuild OpenCore to the internal disk to update the bootloader. + * You can also update root patches but this part is optional in this stage, as they will be wiped by the update. +2. Download the macOS version you want and create an installer USB drive using OCLP as detailed in the original [Creating macOS Installers](http://localhost:8080/OpenCore-Legacy-Patcher/INSTALLER.html) then follow the [Booting OpenCore and macOS](https://dortania.github.io/OpenCore-Legacy-Patcher/BOOT.html) guide boot to into the installer on your USB drive. +3. Start macOS installation and follow the process, do not use Disk Utility if you don't want to wipe your disk. +4. After installation, reinstall [root patches](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#applying-post-install-volume-patches). + +**Note:** Major upgrades may work using System Settings but this is not recommended. + +### Minor updates + +This part is for minor updates, which are also called the "dot updates". Such as `12.x`, `13.x` etc. + +1. Make sure the OCLP app is up to date. +2. Rebuild OpenCore to the internal disk to update the bootloader. + * You can also update root patches but this part is optional in this stage, as they will be wiped by the update. +3. Start update from System Settings. +4. Once installed, go into OCLP app and reinstall [root patches](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#applying-post-install-volume-patches). + +::: warning Important + +If your system requires [KDKSupportPkg](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#kdk-kernel-debug-kit), OCLP will react to it automatically during an update installation. + +Additionally, some systems on Sequoia require [MetallibSupportPkg](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#metallibsupportpkg) during root patching, which requires internet connection to download. If OCLP doesn't see internet connection, it will first offer a patch for WiFi only. You will have to reboot, connect to the internet and rerun root patching for the rest of the patches. + +::: \ No newline at end of file diff --git a/docs/images/OCLP_Booted_Version.png b/docs/images/OCLP_Booted_Version.png new file mode 100644 index 000000000..40f7962f3 Binary files /dev/null and b/docs/images/OCLP_Booted_Version.png differ