Skip to content

Commit

Permalink
Rearrangement of Assets folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
royalgraphx committed Jan 9, 2025
1 parent 3bd709e commit 27012f3
Show file tree
Hide file tree
Showing 125 changed files with 130 additions and 979 deletions.
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
source 'https://rubygems.org'

gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
gem "csv" # csv was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.4.0.
gem "base64" # base64 was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.4.0.
gem "logger" # logger was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.5.0.
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2

gem "just-the-docs", "0.9.0" # pinned to the current release
Expand Down
27 changes: 9 additions & 18 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,18 @@ GEM
specs:
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.2.0)
bigdecimal (3.1.8)
colorator (1.1.0)
concurrent-ruby (1.3.4)
csv (3.3.0)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.0-arm64-darwin)
ffi (1.17.0-x86_64-darwin)
ffi (1.17.0-x86_64-linux-gnu)
ffi (1.17.0)
forwardable-extended (2.6.0)
google-protobuf (4.27.4-arm64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.27.4-x86_64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.27.4-x86_64-linux)
google-protobuf (4.27.4)
bigdecimal
rake (>= 13)
http_parser.rb (0.8.0)
Expand Down Expand Up @@ -63,6 +57,7 @@ GEM
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.4)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
Expand All @@ -75,27 +70,23 @@ GEM
strscan
rouge (4.3.0)
safe_yaml (1.0.5)
sass-embedded (1.77.8-arm64-darwin)
google-protobuf (~> 4.26)
sass-embedded (1.77.8-x86_64-darwin)
google-protobuf (~> 4.26)
sass-embedded (1.77.8-x86_64-linux-gnu)
google-protobuf (~> 4.26)
strscan (3.1.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin-23
x86_64-darwin-22
x86_64-darwin-23
x86_64-linux

DEPENDENCIES
base64
csv
jekyll (~> 4.3.2)
just-the-docs (= 0.9.0)
logger

BUNDLED WITH
2.5.23
2.6.2
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,6 @@ aux_links:
# Makes Aux links open in a new tab. Default is false
# This is required for smooth operation of interlinked pages for navigation
aux_links_new_tab: false

# For copy button on code blocks
enable_copy_code_button: true
2 changes: 1 addition & 1 deletion _hardware/02-Consequences.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ has_toc: false
<h2 align="center">Graphics Related</h2>
<br>
<div align="center">
<a href=""><img src="../../assets/HardwareLimitations/HighSierraNoGPUAccel.gif" alt=""></a>
<a href=""><img src="../../assets/Carnations/HighSierraNoGPUAccel.gif" alt=""></a>
</div>
<p align="center">The most important and absolutely required aspect is a supported Graphics Processing Unit. When you run the Mac operating system without a properly supported graphics card, you are running the entire OS in VESA / VGA mode. This means you have 0 graphics acceleration, it is being done via CPU rendering, which as you can see above, is a non usable experience. Imagine if your Windows PC did not have a graphics card, that's basically what it is to OS X / macOS. If your GPU/iGPU is not in the support chart, you will basically be using the system as if no Graphics Processing Unit exists at all. The Mac operating system heavily relies on a GPU to properly use, because every Mac has always <i>had</i> a GPU that worked (iGPU), and makes heavy use of it for things like Drop Shadows, Gaussian Blur, Dock Transparency, Minimizing/Maximizing animations, and other Aqua effects. The experience is much worse than non accelerated Windows, and is considered to be unusable in this state.</p>

Expand Down
42 changes: 25 additions & 17 deletions _hardware/03-KnowYourHardware/01-Windows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: default
title: Windows
parent: Know Your hardware
description: How to inspect and take note of the hardware present in your system on Windows.
nav_order: 1
has_children: false
has_toc: false
Expand Down Expand Up @@ -75,7 +76,8 @@ In order to easily get the most information from our system, we'll want to use <
<br>

<hr>
<h3 align="center">Finding CPU Name</h3>
<h2 id="finding-cpu-name" align="center">Finding CPU Name</h2>
<br>

<p align="center">To begin, you can quickly find out your CPU Name and Codename with the System Summary that appeared. The upper left corner displays the following useful information:</p>

Expand All @@ -94,7 +96,8 @@ YourMachineName -> Motherboard -> SMBIOS DMI -> Processor
</div>

<hr>
<h3 align="center">Finding GPU Information</h3>
<h2 id="finding-gpu-name" align="center">Finding GPU Information</h2>
<br>

<p align="center">Using the System Summary we can see on the top right, is the GPU information we can note down.</p>

Expand All @@ -117,7 +120,8 @@ YourMachineName -> Video Adapter -> GPU Name
<p align="center">This section also gives you the Vendor and Device ID if a Helper asks for that information, when verifying a specific non-specifically named GPU device like Radeon Graphics.</p>

<hr>
<h3 align="center">Finding Motherboard Name/Chipset</h3>
<h2 id="finding-motherboard-chipset" align="center">Finding Motherboard Name/Chipset</h2>
<br>

<p align="center">Using the System Summary, in the middle top area you will get basic information on the motherboard.</p>

Expand All @@ -144,7 +148,8 @@ YourMachineName -> Motherboard -> SMBIOS DMI -> BIOS
</div>

<hr>
<h3 align="center">Finding Storage Name/Model/Type</h3>
<h2 id="finding-storage-name" align="center">Finding Storage Name/Model/Type</h2>
<br>

<p align="center">You can quickly find basic information such as the Interface Type and Name of your storage in the bottom right corner of the System Summary.</p>

Expand All @@ -171,7 +176,8 @@ YourMachineName -> Drives -> Type -> Name
<p align="center">As you can see above, you can now write or copy/paste the PciRoot data.</p>

<hr>
<h3 align="center">Finding Networking Controllers</h3>
<h2 id="finding-nic-controller" align="center">Finding Networking Controllers</h2>
<br>

<p align="center">You'll need to use the Full System Summary window to view this data.</p>

Expand All @@ -198,7 +204,8 @@ YourMachineName -> Network -> Device Name
<p align="center">This is a great way to find out the Name, Chipset, and the PciRoot of your networking interface of choice.</p>

<hr>
<h3 align="center">Finding Sound Controller and Codecs</h3>
<h2 id="finding-audio-chipset" align="center">Finding Sound Controller and Codecs</h2>
<br>

<p align="center">You'll need to use the Full System Summary window to view this data.</p>

Expand All @@ -210,16 +217,17 @@ YourMachineName -> Audio -> Audio Controller Name
<a href=""><img src="../../../../assets/HWiNFO64/AudioChipsetCodec.png" alt=""></a>
</div>

<p align="center">In the above screenshot, we can see that this specific Audio Controller on the example motherboard, has an <code>ALC1220</code> Codec, and the Vendor/Device ID are visible to note down as well.</p>
<p align="center">In the above screenshot, we can see that this specific Audio Controller on the example motherboard, the Vendor/Device ID are visible to note down, we will require the device-id later for calculating which AppleALC layout to use, and if we need to use AppleALC at all, or another kext for audio.</p>

<div align="center">
<a href=""><img src="../../../../assets/HWiNFO64/AudioChipsetCodecMobile.png" alt=""></a>
</div>

<p align="center">Here's a laptop in HWiNFO64, displaying the codec for the sound controller as <code>ALC285</code> for the motherboard and the Vendor/Device ID are visible to note down as well.</p>
<p align="center">Here's a laptop in HWiNFO64 displaying the Vendor/Device ID, visible to note down as well.</p>

<hr>
<h3 align="center">Finding Input Devices and Type</h3>
<h2 id="finding-input-types" align="center">Finding Input Devices and Type</h2>
<br>

{: .internalnote }
This section is a placeholder outline for Contributors to fill in! Thank you for this, I have 0 laptop experience :P The plan here is to first find the Trackpad/Touchpad, and determine its type, then we move on and figure out Keyboard.
Expand All @@ -246,42 +254,42 @@ This section is specific to Mobile platforms, such as Laptops and Handhelds. If
<p align="center">To get started, begin by opening a new Device Manager window by right clicking your Start Menu and selecting <code>Device Manager</code> to get a new fresh window like so:</p>

<div align="center">
<a href=""><img src="../../../../assets/DeviceManager/FreshWindow.png" alt="Fresh Device Manager Window" style="width:60%;"></a>
<a href=""><img src="../../../../assets/Microsoft/DeviceManager/FreshWindow.png" alt="Fresh Device Manager Window" style="width:60%;"></a>
</div>

<p align="center">We're going to want to click on <code>View -> Device by Connection</code>

<div class="image-container">
<div class="image-item">
<h3>Dropdown Menu</h3>
<a href="../../../../assets/DeviceManager/ByConnectionDropDown.png" target="_blank">
<img src="../../../../assets/DeviceManager/ByConnectionDropDown.png" alt="Dropdown Menu">
<a href="../../../../assets/Microsoft/DeviceManager/ByConnectionDropDown.png" target="_blank">
<img src="../../../../assets/Microsoft/DeviceManager/ByConnectionDropDown.png" alt="Dropdown Menu">
</a>
</div>
<div class="image-item">
<h3>New Window Appearance</h3>
<a href="../../../../assets/DeviceManager/ByConnectionWindow.png" target="_blank">
<img src="../../../../assets/DeviceManager/ByConnectionWindow.png" alt="New Window Appearance">
<a href="../../../../assets/Microsoft/DeviceManager/ByConnectionWindow.png" target="_blank">
<img src="../../../../assets/Microsoft/DeviceManager/ByConnectionWindow.png" alt="New Window Appearance">
</a>
</div>
</div>

<p align="center">Placeholder Step.</p>

<div align="center">
<a href=""><img src="../../../../assets/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
<a href=""><img src="../../../../assets/Microsoft/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
</div>

<p align="center">Placeholder Step.</p>

<div align="center">
<a href=""><img src="../../../../assets/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
<a href=""><img src="../../../../assets/Microsoft/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
</div>

<p align="center">Placeholder Step.</p>

<div align="center">
<a href=""><img src="../../../../assets/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
<a href=""><img src="../../../../assets/Microsoft/DeviceManager/Placeholder.png" alt="[Missing Content] Placeholder"></a>
</div>

<hr>
Expand Down
22 changes: 15 additions & 7 deletions _hardware/03-KnowYourHardware/02-Linux/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: default
title: Linux
parent: Know Your hardware
description: How to inspect and take note of the hardware present in your system on Linux.
nav_order: 2
has_children: false
has_toc: false
Expand Down Expand Up @@ -41,7 +42,8 @@ has_toc: false
The commands below should work regardless of the distribution of Linux you are using! There are multiple ways to get the same information, so if you are missing a package or a command does not work for you, try using the others in the intended section as a last resort.

<br>
<h3 align="center">Finding CPU Name</h3>
<h2 id="finding-cpu-name" align="center">Finding CPU Name</h2>
<br>

<p align="center">The command below will probe /proc/cpuinfo and pretty print you the info you need</p>

Expand All @@ -56,7 +58,8 @@ AMD Ryzen 7 3700X 8-Core Processor
```

<hr>
<h3 align="center">Finding GPU Information</h3>
<h2 id="finding-gpu-name" align="center">Finding GPU Information</h2>
<br>

<p align="center">We'll need to know a decent amount about our Graphics Processing Units. You may have more than one in your system, please note that Integrated and Dedicated GPUs both count and will appear, you will want to know plenty for both. We'll get the GPU Name, the Vendor and Device ID as well. In this section, you'll also get the PCI location of the GPU, in case you require it later to disable non supported GPUs from being visible in OS X / macOS</p>

Expand All @@ -77,7 +80,8 @@ lspci -nn | grep -i -E 'vga|3d|2d|display'
- ``[1002:73ff]`` is the Vendor and Device ID data

<hr>
<h3 align="center">Finding Motherboard Name/Chipset</h3>
<h2 id="finding-motherboard-chipset" align="center">Finding Motherboard Name/Chipset</h2>
<br>

<p align="center">This one is a bit trickier, as the information is not directly exposed in a command typically. Below we will start with the most universal option using Cat and reading from the filesystem.</p>

Expand Down Expand Up @@ -108,7 +112,8 @@ sudo dmidecode -t baseboard | grep -E 'Manufacturer|Product'
```

<hr>
<h3 align="center">Finding Storage Name/Model/Type</h3>
<h2 id="finding-storage-name" align="center">Finding Storage Name/Model/Type</h2>
<br>

<p align="center">Most, if not all Linux installations come with lsblk. We can use it to specifically find out what type of storage we have, and the Product Name/Model of it.</p>

Expand All @@ -125,7 +130,8 @@ nvme2n1 Samsung SSD 980 1TB
```

<hr>
<h3 align="center">Finding Networking Controllers</h3>
<h2 id="finding-nic-controller" align="center">Finding Networking Controllers</h2>
<br>

<p align="center">We can again leverage LSPCI to parse out information related to Networking, and all types available on your system.</p>

Expand All @@ -152,7 +158,8 @@ lspci -nn | grep -i -E 'ethernet|network'
- ``[8086:2725]`` is the Vendor and Device ID data

<hr>
<h3 align="center">Finding Sound Controller and Codecs</h3>
<h2 id="finding-audio-chipset" align="center">Finding Sound Controller and Codecs</h2>
<br>

<p align="center">Like the motherboard information, finding out the specific Codec in use by your Sound Controller is a tad tricky and may require additional packages but, we'll try the universal methods first.</p>

Expand Down Expand Up @@ -200,7 +207,8 @@ card 1: Generic [HD-Audio Generic], device 1: ALC1220 Analog [ALC1220 Analog]
<p align="center">We're looking for something similar to <code>ALC1220</code>. That is the Codec.</p>

<hr>
<h3 align="center">Finding Input Devices and Type</h3>
<h2 id="finding-input-types" align="center">Finding Input Devices and Type</h2>
<br>

{: .note }
This section is specific to Mobile platforms, such as Laptops and Handhelds. If you are on a Desktop, you can safely skip this section of the instructions.
Expand Down
2 changes: 1 addition & 1 deletion _hardware/04-CompatibilityCharts/01-CPU/02-AMD/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ We need to pick through and remove non viable CPUs that would not make a working
Still missing older than Ryzen data such as Bulldozer, Jaguar, and Puma

{: .note }
> No Mac computer has ever shipped with an AMD CPU. Many programs use libraries or CPU features that AMD CPUs cannot handle. Programs affected include, but are not limited to: Discord Krisp, Adobe CC applications, Corel Painter, and others. Carnations Botanica has a Kernel Extension to resolve such issues via <a href="https://github.com/Carnations-Botanica/IntelMKLFixup/">IntelMKLFixup</a> by <a href="https://github.com/irlbunny">Kaitlyn (irlbunny)</a>
> No Mac computer has ever shipped with an AMD CPU. Many programs use libraries or CPU features that AMD CPUs cannot handle. Programs affected include, but are not limited to: Discord Krisp, Adobe CC applications, Corel Painter, and others. Carnations Botanica has a Kernel Extension to resolve such issues via <a href="https://github.com/Carnations-Botanica/IntelMKLFixup/">IntelMKLFixup</a> by <a href="https://github.com/whatdahopper">Kaitlyn</a>
>
> AMD CPUs utilize SVM (Secure Virtual Machine), while Intel CPUs utilize VT-x (Virtualization Extensions) for programs like Docker, Virtualbox, VMware, Parallels, UTM, QEMU, and others. This means you will not have the ability to virtualize on your AMD-based Hac. This is currently an open issue. Possible workarounds are using older versions of software that utilize their own Hypervisor and not Apple HV / Hypervisor.framework, but this is unsafe.
>
Expand Down
4 changes: 2 additions & 2 deletions _includes/footer_custom.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Core Configuration Docs Version 1.0.0~prerelease@restructure</br>
Core Configuration Docs Version 1.0.0~prerelease@CarnationsInternal</br>
Copyright &copy; 2024 Carnations Botánica.</br>
Distributed by a <a href="https://github.com/Carnations-Botanica/Core-Configuration-Docs/blob/main/LICENSE">CC BY-NC-SA 4.0 License</a>.</br>
Last Modified: Sat, 12 Oct 2024 18:04:19 CDT
Last Modified: Thu, 9 Jan 2025 3:19:12 CDT
2 changes: 1 addition & 1 deletion _includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<head>
<meta content="https://raw.githubusercontent.com/Carnations-Botanica/Core-Configuration-Docs/CarnationsInternal/assets/Carnations/Carnations_logo_1000px.png" property="og:image">
<meta content="https://docs.carnations.dev/assets/Carnations/Carnations_logo_1000px.png" property="og:image">
</head>
13 changes: 13 additions & 0 deletions _opencore/02-GatheringFiles/01-EFI/01-ACPI/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ So, what's this talk about SSDTs? What even are they? and what the heck is a DSD

Your firmware (BIOS) contains Tables that hold information that describe the hardware on your system, in a very deep level. For future reference, the DSDT (Differentiated System Description Table) is the direct outline given to an OS by your motherboard. Whereas, an SSDT (Secondary System Description Table) tells the OS extra information and definitions for a specific bit of hardware and how it's being dealt with on the system.

The goal for this folder is to create various SSDTs that will better align your firmwares tables to better fix the expectations of OS X / macOS. There are currently two ways to populate the contents of this folder, the manual way involving manually writing the code that is then compiled into an ``.aml`` file using ``iasl`` or you can use CorpNewt's SSDTTime tool to quickly run through the common patches required by most systems.

We encourage everyone to create their SSDTs with SSDTTime as it dumps the current machines firmware DSDT and files, to create patches using your own local tables. This can be a better alternative than using any prebuilt ``.aml`` files, where applicable.

Before continuing on to the next page depending on your chosen method, please scroll through this page past the navigation bar to make a note of what SSDTs you'll need.

<h2 align="center">
<br>
Expand All @@ -59,3 +63,12 @@ Your firmware (BIOS) contains Tables that hold information that describe the har
<br>
</h2>

<hr>

<h2 align="center">What does my system most likely require?</h2>
<br>

{: .internalnote }
This section will be used to hold a chart of chipsets and common SSDTs required for such chipsets, very similar to the already existing charts from Dortania, but in a different layout as to make it easier to know which to generate via SSDTTime or manually


Loading

0 comments on commit 27012f3

Please sign in to comment.