diff --git a/README.md b/README.md index 185aff23b..aebc2435b 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](https://dortania.github.io/OpenCore-Legacy-Patcher/MODELS.html) on whether your model is supported. +A python program for building and booting [OpenCore](https://github.com/acidanthera/OpenCorePkg) on legacy Macs, see [Supported SMBIOS](https://dortania.github.io/OpenCore-Legacy-Patcher/MODELS.html) on whether your model is supported. Supported features: @@ -32,6 +32,7 @@ Since this patcher tricks macOS into thinking you're running a newer Mac, certai * 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 + * [Add MBR loading tool to OpenCore #912](https://github.com/acidanthera/bugtracker/issues/912) * 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 9bd0e63c2..17501d9c0 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -101,7 +101,15 @@ module.exports = { 'DEBUG', 'UNINSTALL', 'ICNS', + ] + }, + { + title: 'Documentation', + collapsable: false, + sidebarDepth: 1, + children: [ 'TERMS', + 'HOW', 'PATCHEXPLAIN', ] diff --git a/docs/HOW.md b/docs/HOW.md new file mode 100644 index 000000000..54bbce331 --- /dev/null +++ b/docs/HOW.md @@ -0,0 +1,9 @@ +# Boot Process with OpenCore Legacy Patcher + +OpenCore Legacy Patcher itself is actually quite a "dumb" program, and essentially edits a config.plist file and moves files around, it actually has little logic regarding the boot process. The real magic of OCLP is [OpenCorePkg](https://github.com/acidanthera/OpenCorePkg), our back-end and what makes this patcher so powerful. + +## Boot Process with OpenCore + +To understand a bit more of how OpenCore is able revive older Macs in such a native-like way, we need to go over *how* OpenCore works with your Mac: + +![](../images/oc-explained.png) \ No newline at end of file diff --git a/docs/TERMS.md b/docs/TERMS.md index 52182d243..4d74dc48e 100644 --- a/docs/TERMS.md +++ b/docs/TERMS.md @@ -15,13 +15,23 @@ Term | Description Term | Description --- | --- **OpenCore** | The new hotness on the scene, made with security in mind by the [Acidanthera team](https://github.com/acidanthera), has faster booting and lighter weight than previous boot managers. Supports many native Mac features such as SIP, FileVault, Secure Boot, etc -**XNU** | Also known as **X** is **N**ot **U**nix, XNU is referred to as macOS's "kernel" and the heart of what makes macOS tick +**ACPI** | Tables defined in your firmware defining your hardware and different methods, tied directly to how IOKit/IOService handles device setup +**NVRAM** | Non-volitile storage, where many variables are stored including default boot options, Hibernation keys, Secure Boot information, etc +--- +Term | Description +--- | --- +**XNU** | Also known as **X** is **N**ot **U**nix, XNU is referred to as macOS's "kernel" and the heart of what makes macOS tick **Kexts** | Also known as **K**ernel **Ext**ensions, are macOS's drivers. They're used to perform different tasks like device drivers or for a different purpose (in this patcher) like patching the OS, injecting information or running tasks. **KernelCollection** | Also known as the ImmutableKernel and PrelinkedKernel, this is a bundle of the kernel(XNU) and kernel extensions(Kexts) that we use to boot macOS. This is also what OpenCore patches in memory to allow us to have a seamless experience
- PrelinkedKernel: Default caching system since 10.7
- ImmutableKernel: Secure Boot based caching system since 10.13
- KernelCollection: Merge of both Prelinked and ImmutableKernel's since macOS 11, Big Sur +**KernelCollection** | Also known as the ImmutableKernel and PrelinkedKernel, this is a bundle of the kernel(XNU) and kernel extensions(Kexts) that we use to boot macOS. This is also what OpenCore patches in memory to allow us to have a seamless experience
- PrelinkedKernel: Default caching system since 10.7
- ImmutableKernel: Secure Boot based caching system since 10.13
- KernelCollection: Merge of both Prelinked and ImmutableKernel's since macOS 11, Big Sur +**IOKit** | Backbone of how Kernel Extentions (Kexts) probe and attach onto hardware, starts quickly after kernel initates +**WindowServer** | Backbone of the GUI interface in macOS, one of the first userfacing userspace programs to kick-in --- Term | Description --- | --- **EFI** | It can denote two things:
- Mac's firmware, which is the same as UEFI, but pretty modified for Macs only, so not so "Universal"
- The partition on your hard drive that stores software read by the UEFI to load OSes (like the Windows bootloader) or UEFI Applications (like OpenCore), it's FAT32 formatted and has an ID type of EF00 (in hex). It can be named ESP or SYSTEM, and it's usually from 100MB to 400MB in size but the size doesn't reflect upon anything. +**HFS+** | Also known as MacOS Journaled, this was the default macOS drive format up until macOS 10.13, format was designed around spinning disks +**APFS** | This was the default macOS drive from macOS 10.13 and onwards for SSDs, and standard for all drives in Mojave. Format was designed around SSDs primarily. **32 and 64-Bit CPU** | The bit number of a CPU determines how much data a CPU can address.
- 32-Bit CPUs were only supported up-to Mac OS X 10.6, Snow Leopard. **32-Bit Firmware** | The bit number of a Firmware determines how much data the firmware can address. In some older Macs, it's common to have a 64-Bit CPU can have a 32-Bit firmware
- 32-Bit Firmwares were only supported up-to Mac OS X 10.7, Lion. **SSE Instructions** | Also known as **S**IMD **S**ingle-Precision Floating-Point **I**nstructions, these are defined as instruction sets supported by your CPU. In macOS, there are a certain number of instruction sets required for normal operation:
- SSE3: Required for all Intel CPUs since Mac OS X 10.4, Tiger
- SSSE3: Required for all Intel 64-Bit CPUs since Mac OS X 10.6, Snow Leopard
- SSE4.1: Required for all Intel CPUs since macOS 10.12, Sierra diff --git a/docs/package-lock.json b/docs/package-lock.json index 05145215b..c64389e45 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -1,6 +1,6 @@ { "name": "OpenCore-Legacy-Patcher", - "version": "0.6.6", + "version": "0.0.1", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/images/oc-explained.png b/images/oc-explained.png new file mode 100644 index 000000000..69784bda9 Binary files /dev/null and b/images/oc-explained.png differ