diff --git a/docs/altos.md b/docs/altos.md
index 88a10d4b..f2a28473 100644
--- a/docs/altos.md
+++ b/docs/altos.md
@@ -4,12 +4,11 @@ layout: default
nav_order: 10
---
-## altOS Pros / Cons
-
------------------------
+# altOS Pros / Cons
+
-**Windows:**
+## Windows
Pros:
* Works on most platforms with minimal tweaking¹
@@ -26,11 +25,11 @@ Cons:
-¹Some devices such as CELES need workarounds. Additionally, AMD Ryzen devices need to use CoolStar's RW_LEGACY script in order to boot Windows. Refer to the [known issues page](known-issues.html) to check whether you need patches.
+¹Some devices such as CELES need workarounds. Refer to the [known issues page](known-issues.html) to check whether you need patches.
-----------
+---
-**Linux**
+## Linux
Pros:
* Free audio support
@@ -49,10 +48,9 @@ Cons:
### [Installing Linux →](installing-linux.html)
+---
-----------
-
-**macOS**
+## macOS
Pros:
* OS experience is near identical to a Mac
@@ -72,7 +70,6 @@ Any Chromebook with a ARM, Celeron or Pentium CPU is not supported. AMD Ryzen mi
-
diff --git a/docs/bootableusb.md b/docs/bootableusb.md
index b7f131ba..74b1d88c 100644
--- a/docs/bootableusb.md
+++ b/docs/bootableusb.md
@@ -4,23 +4,24 @@ layout: default
nav_order: 27
---
-## Making a Bootable USB
+# Making a Bootable USB
+
{: .warning }
Flashing Ventoy or ISO's to an external drive will **wipe all data** on said drive. Back up anything if you have to.
+
-### Prerequisites
+## Prerequisites
1. Another PC or laptop with at least 8GB storage
2. A internet connection
-3. A external drive like a USB drive or SD card thats at least 8 gigabytes.
+3. A external drive like a USB drive or SD card thats at least 8GB.
-### Downloading a ISO
+## Downloading a ISO
1. Determine what OS you want.
- For Linux, keep in mind Ubuntu and any derivatives not based on 23.10 or higher **may have issues**.
- For Windows, keep in mind only Windows 10 and newer are supported.
2. Place the ISO in a safe place.
-
### Flashing using Rufus (Windows)
For this guide, we will be using Rufus to create our bootable USB.
diff --git a/docs/bugreport.md b/docs/bugreport.md
index 389dabc6..f2e74017 100644
--- a/docs/bugreport.md
+++ b/docs/bugreport.md
@@ -4,7 +4,9 @@ layout: default
nav_order: 28
---
-## Bug Reporting
+# Bug Reporting
+
+
So you find a bug in one of our projects, and want to report it. It's faily simple,
@@ -14,8 +16,8 @@ So you find a bug in one of our projects, and want to report it. It's faily simp
- If you need help, a generic bug report template is available.
4. Wait patiently for a contributor to fix the issue.
- Please keep in mind the majority of us contributors have other things going on in our lives.
+
-{: .note }
+{: .note }
Do not submit personal help requests in the bugtracker.
-
diff --git a/docs/compiling-coreboot.md b/docs/compiling-coreboot.md
index 09f782d8..79cbbbb8 100644
--- a/docs/compiling-coreboot.md
+++ b/docs/compiling-coreboot.md
@@ -5,9 +5,10 @@ nav_order: 20
parent: Advanced
---
-### Cloning & Building ROMs
+# Compiling Custom Firmware
+
-
+## Cloning & Building ROMs
{: .warning }
Building and flashing your own firmware has the potential to brick your device. Do not do this unless you are sure you know what you're doing/have a way to recover from a bad flash. Some level of knowledge with using the Linux command line is required.
diff --git a/docs/csdriver.md b/docs/csdriver.md
index 1e5b76b8..ed7af5ab 100644
--- a/docs/csdriver.md
+++ b/docs/csdriver.md
@@ -7,37 +7,37 @@ nav_order: 14
{: .warning }
If your device is older than Skylake (6th gen), you do **not need to buy any drivers as they are free.**
+# Purchasing CoolStar Drivers
-
-## Purchasing CoolStar Drivers
+
### Step 1:
Go to [CoolStar's Driver Portal](https://coolstar.org/chromebook/driverlicense/login.html) and click "Sign Up with Patreon".
---------
+---
### Step 2:
Click "Sign Up with Patreon" one more time.
---------
+---
### Step 3:
Sign in to Patreon. If you don't have an account, click "Sign Up" at the bottom of the screen and follow the on screen instructions.
---------
+---
### Step 4:
After signing in, you should have been redirected to the screen below. Follow the prompts and click "Submit" when you are done.
---------
+---
### Step 5:
@@ -136,7 +136,6 @@ Visit [CoolStar's Patreon](https://www.patreon.com/coolstar), sign in, then sele
-
{: .important }
@@ -148,14 +147,14 @@ You may need to select "See all 5 levels" if you don't see the driver you want.
{: .note }
To purchase more than one driver, you can change the "Choose what you pay" field at checkout.
---------
+---
### Step 6:
Enter your payment information. You can also pay via PayPal.
---------
+---
### Step 7:
@@ -165,13 +164,13 @@ Go back to the [CoolStar driver portal](https://coolstar.org/chromebook/driverli
{: .note }
It may take up to two (2) hours for the funds to show up. Do not panic, you did not get scammed.
---------
+---
### Step 8:
Once the funds show up, head back to "Available Drivers", select the driver you want to buy, then click "Buy".
---------
+---
### Step 9:
@@ -181,14 +180,7 @@ Once the funds show up, head back to "Available Drivers", select the driver you
{: .warning }
If you do not unsubscribe from the Patreon, you will get charged again next month.
---------
-
-### Step 10:
-Reboot.
-
-
-
---------
+---
diff --git a/docs/debugging.md b/docs/debugging.md
index d5c1877b..756e859f 100644
--- a/docs/debugging.md
+++ b/docs/debugging.md
@@ -5,22 +5,21 @@ nav_order: 19
parent: Advanced
---
-## Debugging
-
+# Debugging
This page has instructions on using multiple different utilities to debug issues and modify parts of your system.
------------
+
-### Grabbing Logs
+## Grabbing Logs
* If you're experiencing firmware bugs, provide output from `cbmem` console.
* If you're experiencing issues with Linux, provide output from `dmesg`, `dmidecode` and `journalctl` or `/var/log/messages`, respectively
-* Ift you're experiencing issues with Windows, provide screenshots from Device Manager, Event Viewer, coredumps etc.
+* If you're experiencing issues with Windows, provide screenshots from Device Manager, Event Viewer, coredumps etc.
* If you're experiencing issues with macOS, please ask for help in the Chrultrabook Discord, in the #hackintosh channel.
------------
+---
-### Firmware
+## Firmware
To debug firmware, you will need the following tools:
@@ -47,9 +46,10 @@ To interface with the Embedded Controller:
* Running `./ectool help` will provide you with a list of available commands, or you can take a look at ectool's source code directly:
https://chromium.googlesource.com/chromiumos/platform/ec/+/master/util/ectool.c#63
------------
+---
+
+## SuzyQ Debug Cable
-### SuzyQ Debug Cable
If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exposes three serial devices:
1. AP (CR50) console under /dev/ttyUSB0:
* `minicom -D /dev/ttyUSB0 -b 115200`
@@ -64,9 +64,9 @@ If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exp
* To use SuzyQ as platform debugger, you will also need to append the following to your kernel commandline:
`loglevel=15 console=ttyS4,115200n8`
------------
+---
-### ACPI and Linux kernelspace
+## ACPI and Linux kernelspace
1. Download our debugging script.
* `cd ~/Desktop;wget https://raw.githubusercontent.com/chrultrabook/linux-tools/main/debugging.sh`
@@ -87,14 +87,13 @@ If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exp
3. Upload this file if you need help with troubleshooting.
* Remember to remove WiFi information from dmesg to protect your privacy.
------------
+---
-### flashrom
+## flashrom
Flashrom is used to read and write from the SPI flash
-
-Read flash:
+### Read flash:
* `sudo flashrom -p -r `
* Example:
* `sudo flashrom -p internal -r backup.rom`
@@ -102,35 +101,35 @@ Read flash:
{: .warning }
If you have an Intel Chromebook, you will need to add `--ifd -i bios` if you want to write to the flash or else flashrom will fail.
-Write flash:
+### Write flash:
* `sudo flashrom -p -w `
* Intel Example:
* `sudo flashrom -p internal --ifd -i bios -w stock.rom`
* AMD Example:
* `sudo flashrom -p internal -w stock.rom`
-Write protection:
+### Write protection:
View status:
* `sudo flashrom -p internal --wp-status`
Enable WP:
- * `sudo flashrom -p internal --wp-enable`
+ * `sudo flashrom -p internal --wp-enable`
Disable WP:
- * `sudo flashrom -p internal --wp-disable`
+ * `sudo flashrom -p internal --wp-disable`
Clear WP range:
- * `sudo flashrom -p internal --wp-range 0 0`
+ * `sudo flashrom -p internal --wp-range 0 0`
Common programmers:
* `internal`: Use this when you run flashrom on the chromebook you want to program.
* `ch341a_spi`: Use this when you use a ch341a external programmer.
* `raiden_debug_spi:target=AP`: Use then when you want to flash using a Suzy-Q cable.
------------
+---
-### gsctool
+## gsctool
gsctool is used to communicate with the GSC (Google Security Chip) from ChromeOS and is usually used to unlock CCD without removing the back of the Chromebook.
@@ -141,4 +140,3 @@ Unlock CCD:
* `sudo gsctool -a -o`
* This will prompt you multiple times to press the power button, on the last time, the device will reboot back into verified mode
-
diff --git a/docs/distros.md b/docs/distros.md
index 8fc47605..62cff880 100644
--- a/docs/distros.md
+++ b/docs/distros.md
@@ -6,11 +6,11 @@ parent: Advanced
---
-## Linux distro-specific Configuration
+# Linux distro-specific Configuration
----------
+
-### NixOS
+## NixOS
- Enable and configure keyd (Example is cros-standard. Adjust as you need!)
```nix
diff --git a/docs/faq.md b/docs/faq.md
index dc786ac8..7112261e 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -6,11 +6,11 @@ nav_order: 2
# FAQ
+
+
{: .highlight }
Please read this page before asking a question in the Discord. Your help request will be ignored if the answer is found on the FAQ.
------
-
**Can I pay for Windows drivers using PayPal?**
* You can pay via PayPal in Patreon.
diff --git a/docs/installing-linux.md b/docs/installing-linux.md
index 1e0cad19..1b613f08 100644
--- a/docs/installing-linux.md
+++ b/docs/installing-linux.md
@@ -4,62 +4,56 @@ layout: default
nav_order: 12
---
-## Installing Linux
+# Installing Linux
Thanks to recent advancements in the chrultrabook community, Linux works really well on most Chromebooks.
-----------------
-
-### Recommended Distributions
-
{: .note }
Only Linux kernel 6.4 or newer is supported.
-{: .warning }
-Ubuntu and Ubuntu-based distributions that are not based on 23.10 or higher **may have issues**.
+---
+
+## Recommended Distributions
{: .warning }
-Debian versions older than Debian 12 (Bookworm) are **not supported**.
+Ubuntu and Ubuntu-based distributions that are not based on 23.10 or higher **may have issues**.
{: .warning }
-Debian 12 (Bookworm) requires a custom kernel, the [audio script](https://chrultrabook.github.io/docs/docs/installing-linux.html#fixing-audio) will automatically install it for you.
+Debian versions older than Debian 12 (Bookworm) are **not supported**. Debian 12 (Bookworm) requires a custom kernel, the [audio script](https://chrultrabook.github.io/docs/docs/installing-linux.html#fixing-audio) will automatically install it for you.
-**Recommended distros as of August 2023 (in no particular order) are:**
+**Recommended distros as of October 2023 (in no particular order) are:**
-* Arch Linux
+* Arch Linux and EndeavourOS
* Fedora
-* OpenSUSE Tumbleweed
+* openSUSE Tumbleweed
* Debian 12 (Bookworm)
-----------------
-
+---
-### Installation:
+## Installation
1. Create a bootable Linux USB. See [here](bootableusb.html) for a guide.
2. Plug the USB Drive into the Chromebook.
-3. Turn on the Chromebook, press `ESC` at the POST screen (when the boot logo appears), and select your USB to boot from.
+3. Turn on the Chromebook, press `ESC` at the POST screen (when the coreboot logo appears), and select your USB to boot from.
4. Install as you would on any other computer.
-5. (Optional) Install Chultrabook Tools for fan controls, backlight controls, system information and more
- See [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller)
+---
---------------
-
+## Fixing Audio
-### Fixing Audio
+You will likely have audio issues after installing Linux. Run the following script to fix them.
- {: .warning }
- Using AVS on a device with max98357a will blow your speakers. You have been warned.
+{: .warning }
+Using AVS on a device with max98357a will blow your speakers. You have been warned.
**Prerequisites**
- Python 3.10 or newer
- Git
-**Installation**
-0. Open a terminal.
-1. `git clone https://github.com/WeirdTreeThing/chromebook-linux-audio`
-2. `cd chromebook-linux-audio`
-3. `./setup-audio`
+**How to run the script**
+1. Open a terminal.
+2. `git clone https://github.com/WeirdTreeThing/chromebook-linux-audio`
+3. `cd chromebook-linux-audio`
+4. `./setup-audio`
For more information please see [WeirdTreeThing's repo](https://github.com/WeirdTreeThing/chromebook-linux-audio)
diff --git a/docs/installing-macos.md b/docs/installing-macos.md
index 592165b8..fef555e9 100644
--- a/docs/installing-macos.md
+++ b/docs/installing-macos.md
@@ -4,8 +4,9 @@ layout: default
nav_order: 13
---
-## Installing macOS
+# Installing macOS
+
Before we begin, it's important to know whether your Chromebook is even supported:
- ARM/AMD CPUs are not supported.
@@ -17,30 +18,27 @@ Before we begin, it's important to know whether your Chromebook is even supporte
* Patience
* This is not a one click setup thing. It usually takes one or more weeks to have a stable hack.
* A USB drive
- * 4 gigabytes or more for a online installer.
- * 32 gigabytes or more for offline installer.
-* The ability to use a command prompt
- * We won't help you if you don't know how to `cd` to a directory.
+ * 4 gigabytes or more for a online installer.
+ * 32 gigabytes or more for offline installer.
+* The ability to use a command line
+ * We won't help you if you don't know how to `cd` to a directory.
--------
+---
-### Known Issues
+## Known Issues
- Broken NVRAM on Comet Lake Devices
- - To fix this, **DISABLE** `DevirtualiseMmio`.
- {: .warning}
- If your device has a Comet Lake CPU, this MUST be disabled.
+ - To fix this, **DISABLE** `DevirtualiseMmio`.
+ {: .warning}
+ If your device has a Comet Lake CPU, this MUST be disabled.
-
- Waking from sleep causes:
- Blank Electron / Chromium apps
- Buggy video playback in web browsers like Firefox or Safari
- Display/Wallpaper settings in SysPref/SysSettings
- Logging out freezes your system
--------
-
-### Tested Devices:
+### Tested Devices
{: .note }
This list is incomplete. Feel free to improve it.
@@ -49,12 +47,12 @@ This list is incomplete. Feel free to improve it.
- Asus C434 (SHYVANA)
- Asus C433 (SHYVANA)
- Acer C720 / C720P (PEPPY)
-- Dell Chromebook 13 7310 (LULU)
-- Google Pixelbook (2017) (EVE)
-- Google Pixel Slate (NOCTURNE)
+- Dell Chromebook 13 7310 (LULU)
+- Google Pixelbook (2017) (EVE)
+- Google Pixel Slate (NOCTURNE)
- Google Pixelbook Go (2019) (ATLAS)
- Dell Latitude 7410 Chromebook Enterprise (DRALLION)
-- Asus Chromebox 2 (CN62) (GUADO)
+- Asus Chromebox 2 (CN62) (GUADO)
- HP Chromebook x360 14c (DRAGONAIR)
- Acer Chromebook Spin 713 (CP713-2W) (KLED)
@@ -76,37 +74,36 @@ This list is incomplete. Feel free to improve it.
* [LuluMacOS](https://isi95010.github.io/LuluMacOS/)
* Dell Chromebook 13 7310 (LULU)
+---
--------
-
-### Installing macOS
+## Installation
**Getting Started:**
1. Follow the [Dortania guide](https://dortania.github.io/OpenCore-Install-Guide).
2. Follow the laptop guide for your CPU generation
- * Amber Lake Chromebooks should follow the Kaby Lake config.plist setup
+ * Amber Lake Chromebooks should follow the Kaby Lake config.plist setup
3. As necessary, add the following Kexts and SSDTs to your EFI:
Firmware Fixes:
- * [croscorebootpatch](https://github.com/meghan06/croscorebootpatch): Fixes freeze during boot when using coreboot 4.20 and newer
+ * [croscorebootpatch](https://github.com/meghan06/croscorebootpatch): Fixes freeze during boot when using coreboot 4.20 and newer
Keyboard:
-* [VoodooPS2.kext](https://github.com/1Revenger1/VoodooPS2/releases): Fork of Acidanthera's VoodooPS2 which allows mapping keyboard brightness and other useful keys
-* [Keyboard Map](https://github.com/1Revenger1/Acer-Spin-713-Hackintosh/blob/main/src/ACPI/SSDT-ChromeKeys.dsl): Maps FNx keys to ChromeOS mapping. This is an example, you may need to do your own mapping.
- * Will need to be compiled with either `iASL` or `MaciASL`.
+ * [VoodooPS2.kext](https://github.com/1Revenger1/VoodooPS2/releases): Fork of Acidanthera's VoodooPS2 which allows mapping keyboard brightness and other useful keys
+ * [Keyboard Map](https://github.com/1Revenger1/Acer-Spin-713-Hackintosh/blob/main/src/ACPI/SSDT-ChromeKeys.dsl): Maps FNx keys to ChromeOS mapping. This is an example, you may need to do your own mapping.
+ * Will need to be compiled with either `iASL` or `MaciASL`.
Chrome EC:
-* [CrosEC.kext](https://github.com/1Revenger1/CrosEC/releases): Adds keyboard brightness, tablet mode, and other functionality
-* [Fake Ambient Light Sensor](https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/AcpiSamples/Source/SSDT-ALS0.dsl): Creates a fake ambient light sensor which is needed by macOS to recognize the keyboard backlight.
- * This is only needed if your device does not come with a light sensor.
- * A pre-compiled version comes in OpenCore's release zip under `Docs/AcpiSamples/Binaries/SSDT-ASL0.aml`
+ * [CrosEC.kext](https://github.com/1Revenger1/CrosEC/releases): Adds keyboard brightness, tablet mode, and other functionality
+ * [Fake Ambient Light Sensor](https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/AcpiSamples/Source/SSDT-ALS0.dsl): Creates a fake ambient light sensor which is needed by macOS to recognize the keyboard backlight.
+ * This is only needed if your device does not come with a light sensor.
+ * A pre-compiled version comes in OpenCore's release zip under `Docs/AcpiSamples/Binaries/SSDT-ASL0.aml`
Storage:
- * [EmeraldSDHC.kext](https://github.com/acidanthera/EmeraldSDHC/releases): eMMC driver
+ * [EmeraldSDHC.kext](https://github.com/acidanthera/EmeraldSDHC/releases): eMMC driver
-1. Take those files you downloaded and put the `.aml` files in the ACPI folder, and the `.kexts` into the kexts folder
-1. Snapshot (cmd +r) or (ctrl + r) your `config.plist`.
+4. Take those files you downloaded and put the `.aml` files in the ACPI folder, and the `.kexts` into the kexts folder
+5. Snapshot (cmd +r) or (ctrl + r) your `config.plist`.
{: .warning }
If you dualboot with the SSDTs mentioned above, you might run into issues on other OSes. An `OSI_` check is not present in these SSDTs.
@@ -123,6 +120,3 @@ If you dualboot with the SSDTs mentioned above, you might run into issues on oth
-
-
-
diff --git a/docs/installing-windows.md b/docs/installing-windows.md
index 8855ab8e..e0b36d06 100644
--- a/docs/installing-windows.md
+++ b/docs/installing-windows.md
@@ -4,10 +4,14 @@ layout: default
nav_order: 11
---
-## Installing Windows
+# Installing Windows
+### Terminology
-### Installation:
+| **Term** | **Description** |
+| - | - |
+| UEFI | The Unified Extensible Firmware Interface (UEFI) is a specification that defines a software interface between an operating system and platform firmware. UEFI replaces the legacy Basic Input/Output System (BIOS) firmware interface originally present in all IBM PC-compatible personal computers, with most UEFI firmware implementations providing support for legacy BIOS services. UEFI can support remote diagnostics and repair of computers, even with no operating system installed. (source: Wikipedia)
+| POST | Stands for **P**ower **O**n **S**elf **T**est. POST is a process performed by firmware or software routines immediately after a computer or other digital electronic device is powered on.
@@ -17,53 +21,58 @@ Do not use Windows 8 or older. Only recent Windows 10 and 11 builds are supporte
{: .warning }
Do not use unofficial versions of Windows, such as Ghost Specter or tiny10/11. They are not supported and may contain **undetectable** malware and/or security vulnerabilities.
+---
+
+## Installation
+
{: .note }
-If you want to create a Windows installer from ChromeOS, see the [Installing Ventoy](https://chrultrabook.github.io/docs/docs/ventoy.html) page.
+If you want to create a Windows installer from chromeOS, see the [Installing Ventoy](https://chrultrabook.github.io/docs/docs/ventoy.html) page.
1. Install Windows from a USB:
- 1. On another computer, create a Windows 10 or 11 installer with Rufus as "GPT for UEFI"
- 2. Plug the USB Drive into the Chromebook
- 3. Plug a USB mouse in for installation (If you only have one USB port, use tab, enter, and space to navigate the menu)
- 4. Turn on the Chromebook, press ESC at the POST screen, and select the USB to boot from.
-
- {: .note }
- If you need to select a different boot device, press any key in "Select Boot Option". Then select "Boot Manager" to select your boot drive.
-
- {: .warning }
- **Do NOT** unplug the install USB until the installation has completed. If you do so, the installation will fail as the Windows install file won't exist anymore.
-
-2. Bypassing Windows 11 installation checks using Rufus (Windows on an another computer):
- 1. Select your Flashdrive
- 2. Select your Windows 11 iso in rufus
- 3. Change Partition Scheme from MBR to GPT
- 4. Click on ```Start```
- 5. On the Window named ```Windows User Experience``` click on the option labed ```Remove Requirement for 4GB+ Ram, Secure Boot, and TPM 2.0```
- 6. Click on ```ok```
- 7. You can now install Windows 11 normally without extra steps
-4. Bypassing Windows 11 installation checks:
- 1. At the Windows installer, press Shift + F10 (Volume Up) to open command prompt
- 2. Type in "regedit" and press enter
- 3. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\Setup
- 4. Right click setup and create a new Key called "LabConfig"
- 5. Right click LabConfig and create new DWORD (32 bit) called "BypassSecureBootCheck" and set it to 1
- 6. Right click LabConfig and create new DWORD (32 bit) called "BypassTPMCheck" and set it to 1
- 7. Close regedit and command prompt and proceed with installation normally
-
-5. Install drivers:
- See [Coolstar's Windows Install Helper](https://coolstar.org/chromebook/windows-install.html) for drivers.
-
-6. (Optional) Install Chultrabook Tools for fan controls, backlight controls, system information and more
- see [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller)
+
+ 1. On another computer, create a Windows 10 or 11 installer with Rufus as "GPT for UEFI"
+ 2. Plug the USB drive into the Chromebook
+ 3. Plug a USB mouse in for installation (If you only have one USB port, use tab, enter, and space to navigate the menu)
+ 4. Turn on the Chromebook, press ESC at the POST screen, and select the USB to boot from
+
+ {: .note }
+ If you need to select a different boot device, press any key in "Select Boot Option". Then select "Boot Manager" to select your boot drive.
+
+ {: .warning }
+ **DO NOT** unplug the install USB until the installation has completed. If you do so, the installation will fail as the Windows install file won't exist anymore.
+
+2. Bypassing Windows 11 installation checks using Rufus (Windows on an another computer):
+
+ 1. Select your flash drive
+ 2. Select your Windows 11 ISO in Rufus
+ 3. Change Partition Scheme from MBR to GPT
+ 4. Click on ```Start```
+ 5. On the window named ```Windows User Experience``` click on the option labeled ```Remove Requirement for 4GB+ Ram, Secure Boot, and TPM 2.0```
+ 6. Click on ```ok```
+ 7. You can now install Windows 11 normally without needing to follow step 3
+
+3. Bypassing Windows 11 installation checks:
+
+ 1. At the Windows installer, press Shift + F10 (Volume Up) to open Command Prompt
+ 2. Type in "regedit" and press Enter
+ 3. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\Setup
+ 4. Right click Setup and create a new Key called "LabConfig"
+ 5. Right click LabConfig and create new DWORD (32-bit) called "BypassSecureBootCheck" and set its value to 1
+ 6. Right click LabConfig and create new DWORD (32-bit) called "BypassTPMCheck" and set its value to 1
+ 7. Close Registry Editor and Command Prompt and proceed with installation normally
+
+4. Install drivers:
+ See [Coolstar's Windows Install Helper](https://coolstar.org/chromebook/windows-install.html) for drivers. Some of the drivers may be paid.
---
-### Paid Drivers
+## Paid Drivers
Please see [here](csdriver.html) for a step by step tutorial on purchasing drivers.
---------------
+---
-### **What drivers do I need to buy?**
+### What drivers do I need to buy?
| CPU Generation | Paid Drivers | Notes |
| ---------------- | ---------------- | ------------- |
@@ -83,7 +92,8 @@ Please see [here](csdriver.html) for a step by step tutorial on purchasing drive
| **Tiger Lake** | SOF, TB4 | TB4 and SOF can be purchased as a bundle.
| **Jasper Lake** | SOF |
| **Alder Lake** | SOF, TB4 | TB4 and SOF can be purchased as a bundle.
-
+| **Cezanne** | SOF |
+| **Mendocino** | SOF |
{: .fs-5 }
{: .text-right }
@@ -97,4 +107,3 @@ Please see [here](csdriver.html) for a step by step tutorial on purchasing drive
Post Install →
|
-
diff --git a/docs/known-issues.md b/docs/known-issues.md
index 58e96c3d..d29baaf4 100644
--- a/docs/known-issues.md
+++ b/docs/known-issues.md
@@ -7,32 +7,27 @@ nav_order: 3
# Known Issues
The following page is aimed for documenting all issues Chrultrabooks face. Feel free to improve this page by contributing to it.
-{: .highlight }
-You should avoid buying any devices in this list.
+
------
+## Devices
+{: .highlight }
+You should avoid buying any devices in this list.
-## Devices
* Samsung Chromebook 3 (CELES): Numerous hardware bugs that make it difficult to use.
* Samsung Galaxy Chromebook (KOHAKU): Badly designed hardware, deteriorating trackpad grounding, possibly faulty backlight circuit.
* Samsung Chromebox Series 3 (STUMPY): DisplayPort output is non-functional under Windows, and VGA output through the DVI port is non-functional.
-
-
-
-----
+---
## Firmware
-* **All** ARM Chromebooks: No support, though development is slowly starting.
+* **All ARM Chromebooks**: No support, though development is slowly starting.
* GeminiLake: Legacy boot mode/alternative firmware menu works but does not show payload list
-* AMD Stoneyridge: Some StoneyRidge devices may not currently have functional Legacy Boot Mode due to bugs in Google's firmware.
+* AMD Stoneyridge: Some Stoney Ridge devices may not currently have functional Legacy Boot Mode due to bugs in Google's firmware.
* AMD Picasso: Booting from eMMC is not currently supported (edk2 limitation), only from NVMe and USB/SD.
* AMD Cezanne: legacy boot mode/alternative firmware menu works, edk2 boots, but screen backlight is off. Will be fixed in next Google fw update (fingers crossed).
-
-
-----
+---
## Operating Systems
@@ -42,18 +37,15 @@ You should avoid buying any devices in this list.
* No fingerprint reader support
* No TPM support
* No IPU camera support
-* OS will BSOD with AVS/SOF driver installer when transitioning from sleep
-
### Linux
* Broken USB-C on TigerLake and AlderLake. See Post Install -> Linux for fix.
* No fingerprint reader support
-* Debian 12 Bookworm needs a custom kernel
+* Debian 12 (Bookworm) needs a custom kernel
### macOS
-
* Broken DRM
* No audio
* No PCIe SD card reader support
diff --git a/docs/post-install.md b/docs/post-install.md
index 954e1d88..715186d7 100644
--- a/docs/post-install.md
+++ b/docs/post-install.md
@@ -4,15 +4,17 @@ layout: default
nav_order: 16
---
-## Post Install for altOS
+# Post Install for altOS
+## Windows
-### Windows
+{: .highlight }
+Install [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller/releases) for fan controls, keyboard backlight controls, system information and more.
**Drivers and QOL improvements**
* Compress the install with `compact.exe /compactos:always` in a Command Prompt with admin privileges if necessary.
* Install [CoolStar's drivers](https://coolstar.org/chromebook/windows-install.html) if you haven't already
-* Buy audio drivers (if needed), see [the guide](csdriver.html)
+* Buy audio and Thunderbolt/USB4 drivers (if needed), see [Purchasing Drivers](csdriver.html)
**CELES Post Install Workaround**
@@ -21,21 +23,24 @@ nav_order: 16
3. Type `bcdedit /set {default} useplatformclock true` and press Enter.
4. Reboot
------------------------
+---
+## Linux
-### Linux
+{: .highlight }
+Install [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller/releases) for fan controls, keyboard backlight controls, system information and more.
**General QOL Fixes**
* Run the [audio script](https://github.com/WeirdTreeThing/chromebook-linux-audio) if you haven't already.
* Run the [cros-keyboard-map](https://github.com/WeirdTreeThing/cros-keyboard-map) script to remap top row FX keys.
-**Fixing USB C on TigerLake and AlderLake**
+**Fixing USB-C on TigerLake and AlderLake**
+
1. Create a file called `chromebook-usbc.service` file in `/etc/systemd/system/`
2. Paste the following contents into the file:
- ```
+ ```
[Unit]
Description=Enable USB-C on chromebook
@@ -48,23 +53,25 @@ nav_order: 16
[Install]
WantedBy=multi-user.target
```
+
3. Enable the systemd service by typing `systemctl enable --now chromebook-usbc.service`, then it should work.
**CELES Post Install Workaround**
If you experience issues in applications such as Parsec, or encounter disruptive freezes, adding the kernel parameters `clocksource=hpet hpet=force` may fix your problem. The following instructions assume you're using GRUB, and will be different for other bootloaders. Do your own research on how to set kernel parameters in your bootloader if these do not apply.
+
1. Edit `/etc/default/grub` with your preferred text editor (e.g. nano).
2. Add `clocksource=hpet hpet=force` inside of GRUB_CMDLINE_LINUX_DEFAULT and save your changes. If you exclude either parameter, this will not work. Use sudo, su, or doas if necessary.
3. Type `grub-mkconfig -o /boot/grub/grub.cfg` or `update-grub` into a terminal and press Enter. Use sudo, su, or doas if necessary.
4. Reboot
------------------------
+---
+## macOS
-### macOS
* [Remove Verbose](https://dortania.github.io/OpenCore-Post-Install/cosmetic/verbose.html#macos-decluttering)
-* [OpenCore GUI](https://dortania.github.io/OpenCore-Post-Install/cosmetic/gui.html#setting-up-opencore-s-gui)
-* Disable `DevirtualiseMmio` if you're on CML (CometLake, 10th generation)
+* [OpenCore GUI Setup](https://dortania.github.io/OpenCore-Post-Install/cosmetic/gui.html#setting-up-opencore-s-gui)
+* Disable `DevirtualiseMmio` if you're on CometLake (10th gen)
diff --git a/docs/reverting.md b/docs/reverting.md
index b4d6b6f9..2c010b0a 100644
--- a/docs/reverting.md
+++ b/docs/reverting.md
@@ -4,11 +4,12 @@ layout: default
nav_order: 25
---
+# Reverting to Stock chromeOS
-## Reverting to Stock chromeOS
+
-{: .note }
-If your device hit AUE (Auto Update Expiration), you will not be able to revert to chromeOS.
+{: .important }
+If your device has hit AUE (Auto Update Expiration), you will not be able to revert to chromeOS.
{: .warning }
Reverting to stock without your backup ROM is somewhat difficult and will not be covered in this guide currently.
@@ -16,43 +17,35 @@ Reverting to stock without your backup ROM is somewhat difficult and will not be
{: .note }
If recovery fails, unplug the battery since recovery also attempts to update the firmware.
---------
+## Requirements
-**Requirements**
- A PC or laptop to make a ChromeOS recovery USB
-- A USB drive thats at least 8GB
-- A understanding that this guide has the potential to brick your device.
+- An 8GB or larger USB drive
+- An understanding that this guide has the potential to brick your device
- Your stock ROM backup
-
----------
-
-**Flashing Stock Firmware**
+## Flashing Stock Firmware
1. Boot a live Linux USB (Ubuntu 22.04 or later recommended)
2. Connect to WiFi
3. Open a terminal, then update and install `curl`
- * `sudo apt update`
- * `sudo apt install curl`
+ * `sudo apt update`
+ * `sudo apt install curl`
4. Obtain your ROM backup
5. Run the Firmware Utility Script
- * `cd; curl -LO mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh`
-6. Select the option to revert to stock.
-7. Follow on screen instructions
+ * `cd; curl -LO mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh`
+6. Select the option to revert to stock
+7. Follow on-screen instructions
+## Making a Recovery USB
-**Making a Recovery USB**
1. Download the [Chromebook Recovery Utility](https://chrome.google.com/webstore/detail/chromebook-recovery-utili/pocpnlppkickgojjlmhdmidojbmbodfm) from the Chrome Web Store
2. Launch the app, then follow on-screen instructions. If you are unable to find your device, you can select the "Select a model from a list" option.
3. Select the USB drive you want to use
-4. Wait for it to complete.
+4. Wait for it to complete
+## Booting the Recovery USB
-**Booting the Recovery USB**
1. Press `esc` + `refresh` + `power`
2. Plug in your recovery USB drive
3. Begin the recovery process
-
--------------
-
-
diff --git a/docs/signedlicense.md b/docs/signedlicense.md
index 612e1380..c94012c2 100644
--- a/docs/signedlicense.md
+++ b/docs/signedlicense.md
@@ -7,32 +7,33 @@ nav_order: 15
{: .warning }
Make sure to unsubscribe from CoolStar's Patreon after installing the drivers. **You WILL be charged the following month if you don't.**
-## License Activation
+# License Activation
+
### Step 1:
Sign into [CoolStar's Driver Portal](https://coolstar.org/chromebook/driverlicense/login.html) and head towards "Signed Licenses". Then, click the driver you want to install. Click the download button.
-------
+---
### Step 2:
Once downloaded, extract the zip file.
-------
+---
### Step 3:
Read the README first. Then launch `csaudiosstavs.1.0.3-installer.exe`. Make sure you allow it to run as administrator.
-------
+---
### Step 4:
You might get a message like this when opening it for the first time. Click "More Info", then "Run anyway"
-------
+---
### Step 5:
Click the install button.
@@ -41,7 +42,7 @@ Click the install button.
{: .note }
Leave all of the boxes checked. Ones not for your system simply won't be installed.
-------
+---
### Step 6:
Once the driver install has finished, head to the `gui` folder. Then open `GenLicense.exe`.
@@ -50,7 +51,7 @@ Once the driver install has finished, head to the `gui` folder. Then open `GenLi
{: .note }
Make sure you allow it to run as administrator. You may get another SmartScreen warning, simply click "More Info", then "Run anyway".
-------
+---
### Step 7:
Follow the on screen instructions to generate a license.
@@ -59,20 +60,19 @@ Follow the on screen instructions to generate a license.
{: .warning }
This step is crucial. The drivers will not work without a valid license.
-------
+---
### Step 8:
Reboot.
-Thats it! If you followed all the steps correctly, your drivers should be working.
+That's it! If you followed all the steps correctly, your drivers should be working.
{: .warning }
**If you do not unsubscribe from CoolStar's Patreon after installing the audio drivers, you WILL be charged the following month.** This is your final warning.
-
-------
+---
diff --git a/docs/system-info.md b/docs/system-info.md
index 8a224213..fa21e233 100644
--- a/docs/system-info.md
+++ b/docs/system-info.md
@@ -4,10 +4,14 @@ layout: default
nav_order: 5
---
+# Finding System Info
+
+
+
{: .note }
Some of the following commands require [Developer mode](firmware.html).
-### System Architecture
+## System Architecture
Your system architecture is very important as it determines if your device has any support at all. ARM devices are not currently supported by the project, but support for them in the future is planned.
@@ -21,15 +25,16 @@ You should now see one of three possible outputs:
2. `aarch64`
3. `armv7l`
-If you see `x86_64`, your device is very likely to be supported, you will need to find your board name next to see if your device is supported. If you see `armv7l`, `aarch64`, or anything with `arm`, you have an ARM device which isn't currently supported.
+If you see `x86_64`, your device is very likely to be supported, you will need to find your board name next to see if your device is supported. If you see `armv7l`, `aarch64` or anything with `arm`, you have an ARM device which isn't currently supported.
--------------------
+---
-### Board Name
+## Board Name
The board name is the special name for your device which determines if it is supported by the custom firmware.
-**How to find your board name**
+### How to find your board name
+
1. Open a crosh terminal by pressing `Control` + `Alt` + `T`
2. Type `shell` and press enter
3. Type `sudo crossystem hwid` and press enter
@@ -38,13 +43,14 @@ You should now see your board name and some extra characters.
Example: `SNAPPY E25-A7C-J2L-I74-A47`
In this example, `SNAPPY` is the board name and you can ignore the extra characters.
--------------------
+---
-### CPU Model and generation
+## CPU Model and generation
The CPU model and generation is used to determine OS support and any extra steps you have to take after installing the OS.
-**How to find your CPU model**
+### How to find your CPU model
+
1. Open a crosh terminal by pressing `Control` + `Alt` + `T`
2. Type `shell` and press enter
3. Type `cat /proc/cpuinfo | grep "model name"` and press enter
@@ -52,14 +58,14 @@ The CPU model and generation is used to determine OS support and any extra steps
You should now see your CPU model repeated a few times, we only have to look at the first line.
Example output: `model name : Intel(R) Celeron(R) CPU N3350 @ 1.10GHz`
-**How to find your CPU generation**
+### How to find your CPU generation
+
1. Find your board name using the steps above (ex: `SNAPPY`).
2. Go to the [Supported Devices Page](supported-devices.html).
3. The Supported Devices Page has sections for each generation that has a list of boards for that specific generation. Use Ctrl + F to locate your board and find which generation it's listed under.
{: .fs-5 }
-
diff --git a/docs/terminology.md b/docs/terminology.md
index 5508a9b8..88af525c 100644
--- a/docs/terminology.md
+++ b/docs/terminology.md
@@ -4,7 +4,9 @@ layout: default
nav_order: 6
---
-## Terminology
+# Terminology
+
+
| **Term** | **Description** |
| - | - |
@@ -37,8 +39,7 @@ nav_order: 6
| Kext(s) | Kernel Extensions, also referred to as Kexts, serve as drivers for macOS. They have various functions, such as facilitating device drivers or serving alternative purposes within Hackintoshing, such as OS patching, information injection, or task execution. It is worth noting that while Kexts play a crucial role in a successful Hackintosh setup, they are typically paired with ACPI patches and fixes.
| ch341a | A USB programmer used to read/write firmware. You'll need this if you bricked your system
-
---------
+---
diff --git a/docs/unbrick-flipper.md b/docs/unbrick-flipper.md
index 0c5a96ba..dba444b9 100644
--- a/docs/unbrick-flipper.md
+++ b/docs/unbrick-flipper.md
@@ -5,10 +5,12 @@ nav_order: 23
parent: Advanced
---
-## Unbricking with a Flipper Zero
+# Unbricking with a Flipper Zero
Yes, this is possible.
-### Prerequisites
+
+
+## Prerequisites
- Your brain (please)
- A Flipper Zero with up-to-date firmware
- It doesn't matter if you're using stock or custom FW.
@@ -18,79 +20,47 @@ Yes, this is possible.
- A copy of your stock ROM
- A way to copy files onto your Flipper Zero
-
-
-----------------
-
-### Preparations
+## Preparations
1. Locate the SPI flash chip (See [Unbricking Page](unbricking.html), under "Hardware Disassembly")
2. A understanding that this may not work on your system
-----------------
+## Steps
+
{: .warning }
**You will NOT be able to preserve the VPD using this method! This will not apply to you if flashing via your backup ROM.** Read the [Unbricking Page](unbricking.html) for more information.
-
-
### Step 1
Obtain your stock ROM and rename it to `.bin`. For this guide, I will be using qFlipper. Your rom file should now look like this:
-
-
+
### Step 2
-Locate the `spi_mem_manager` folder under the path `SD Card/apps_data/spi_mem_manager/`. Copy the .bin file to this newly made folder.
-
+Locate the `spi_mem_manager` folder under the path `SD Card/apps_data/spi_mem_manager/`. Copy the .bin file to this newly made folder.
{: .note }
You might see a file size warning. It is safe to ignore it, only files that are 4GB+ will have issues transferring.
Your `spi_mem_manager/` folder should now look like this:
-
### Step 3
On your Flipper Zero, go to `Apps -> GPIO -> SPI Mem Manager -> Saved`. You should see your backup .bin. Verify that the file is there, then proceed to the next step.
-
### Step 4
Connect your SOIC clip chip to your GPIO pins now. See the image below for the wire setup.
-
### Step 5
Go back to `Apps -> GPIO -> SPI Mem Manager -> Saved -> Yourfilename.bim`. Open the file, then select the option to "Write".
-
### Step 6
Assuming all went well, you should no longer have a unbricked system.
-
-----------------
-
-
+---
-#### Got Questions?
+## Got Questions?
Please ask in the Chrultrabook Discord, or email me (meghan6) at (meghann6@proton.me).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/unbricking.md b/docs/unbricking.md
index 348b8b4a..80aa3ab5 100644
--- a/docs/unbricking.md
+++ b/docs/unbricking.md
@@ -5,36 +5,33 @@ nav_order: 21
parent: Advanced
---
-## Unbricking
+# Unbricking
If you've found your way here, it's likely because you updated your firmware and, despite best efforts to minimize the possibility, something went wrong. Thankfully, most Chromebooks can be easily unbricked using cheap, readily available hardware: older Chromebooks using a ch341a USB programmer from Amazon/eBay/Alibaba (and many other sources), and newer (2017+) Chromebooks using a USB-C debug cable (aka Suzy-Q cable).
------------
+
-### Unbricking/Flashing with a ch341a USB programmer
+## Unbricking/Flashing with a ch341a USB programmer
-**Requirements**
+### Requirements
-* A ChromeOS device
+1. A ChromeOS device
- {: .note }
- Most Skylake and older models (with a few exceptions) use a SOIC-8 flash chip which is easily clipable. Most if not all Kabylake/Apollolake and newer devices use a WSON-8 flash chip which can't be clipped, instead you need a WSON-8 probe. Check the part number of your flash chip to find the correct size needed.
+ {: .note }
+ Most Skylake and older models (with a few exceptions) use a SOIC-8 flash chip which is easily clippable. Most if not all Kabylake/Apollolake and newer devices use a WSON-8 flash chip which can't be clipped, instead you need a WSON-8 probe. Check the part number of your flash chip to find the correct size needed.
-* A device running Linux from which to run flashrom. For this guide, I will use a Ubuntu 23.04 live USB.
-* A ch341a USB flash programmer
-* A 1.8v adapter
+2. A device running Linux from which to run flashrom. For this guide, I will use a Ubuntu 23.04 live USB.
+3. A ch341a USB flash programmer
+4. A 1.8v adapter
- {: .note }
- The adapter is required for devices which use 1.8v flash chips. Some/Most Baytrail, Braswell, Skylake and many newer devices use a 1.8v flash chip. Baytrail is more reliable flashing at 3.3v though due to current leakage
+ {: .note }
+ The adapter is required for devices which use 1.8v flash chips. Some/Most Baytrail, Braswell, Skylake and many newer devices use a 1.8v flash chip. Baytrail is more reliable flashing at 3.3v though due to current leakage
-* Either a SOIC-8 chip clip or a WSON-8 probe
+5. Either a SOIC-8 chip clip or a WSON-8 probe
A ch341a programmer, 1.8v adapter, and a SOIC-8 clip are often bundled together at a lower cost, and if you're unsure if your device uses a 1.8v flash chip or a 3.3v one, it makes sense to have the adapter on hand if needed. You can look up the part number of your flash chip to determine which voltage it needs.
-
---------------------------
-
-**Hardware Disassembly**
+### Hardware Disassembly
While this is somewhat device-specific, the main points are the same:
@@ -52,13 +49,9 @@ While this is somewhat device-specific, the main points are the same:
{: .note }
Pin 1 of the flash chip will be notated by a dot/depression on the chip; be sure to align this with pin 1 on the chip clip wiring.
-
Googling should locate a disassembly guide for most models. If you can't find one for your exact model, try to find one for another model of the same manufacturer as the bottom cover removal tends to be very similar.
-
---------------------------
-
-**Prepping to Flash**
+### Prepping to Flash
Once you have your device disassembled and flash chip located, boot up the flashing environment. Most any Linux setup should do as long as either flashrom is available from the distro's software repositories, or it's 64-bit x86 (in which case you can download a statically compiled build of flashrom from mrchromebox.tech). This guide will use a Ubuntu 23.04 live session booted from USB.
@@ -104,9 +97,7 @@ Flashrom will produce output identifying the flash chip. If it doesn't, double c
{: .note }
If you're not sure which file to use for your device / don't know your device's board name, you can reference [the supported devices page](supported-device.html).
-----------
-
-**Persisting the board's Vital Product Data (VPD)**
+### Persisting the board's Vital Product Data (VPD)
The firmware in all ChromeOS devices contains a section (RO_VPD) which stores board-specific data, like the serial number, localization settings, and on many devices which have an Ethernet port, the LAN MAC address as well. When flashing via the Firmware Utility Script, the script will automatically extract this from the running firmware and inject it into the firmware to be flashed, so the device serial, LAN MAC address, etc are all maintained. Without this, the device will use a default/generic LAN MAC address set by coreboot. While not ideal, this is only really an issue if two or more of the same device are on the same LAN segment (or you're statically assigning IP addresses based on MAC). But for completeness, if flashing the UEFI firmware or shellball ROM, we'll extract the VPD (either from the board itself or a backup made by the script) and inject it into the firmware to be flashed.
@@ -127,7 +118,7 @@ Now the firmware image is ready to be flashed, and will maintain the device's un
-----------------
-**Flashing Your Device**
+### Flashing Your Device
Now that everything is prepped, time to flash the device. To be thorough, we'll perform a 2nd verification after flashing to ensure the integrity of the flashed firmware.
@@ -149,19 +140,16 @@ Even though flashrom does this as part of the write process, verifying the entir
* `sudo flashrom -p ch341a_spi -v `
* Using the same filename as before. If the verification passes, then disconnect the CH341a from the host machine, and then remove the chip clip.
-------------------
-
-**Clean Up**
+### Clean Up
Reassembly is the reverse of disassembly. Reconnect the internal battery and replace the bottom cover. Flip over the device, connect external power, press the power button, and cross your fingers :)
---------------
+---
-### Unbricking/Flashing with a Suzy-Q cable
+## Unbricking/Flashing with a Suzy-Q cable
------------
+### Requirements
-**Requirements**
* A ChromeOS device with CCD (closed-case debugging) enabled on one of the USB-C ports. If your device uses CR50 for the firmware write protection, then it has CCD capability.
{: .warning }
@@ -171,9 +159,7 @@ Reassembly is the reverse of disassembly. Reconnect the internal battery and rep
* The device must have the CCD flags factory reset (as per instructions to disable firmware write protection), or the battery must be unplugged/disconnected from the mainboard.
* Another device running Linux, preferably a current Debian/Ubuntu-based distro
------------
-
-**Hardware Disassembly**
+### Hardware Disassembly
As above, this is only needed if you failed to factory reset the CCD flags as part of disabling the device's firmware write-protection. While this is somewhat device-specific, the main points are the same:
@@ -181,13 +167,10 @@ As above, this is only needed if you failed to factory reset the CCD flags as pa
* Remove bottom cover (screws are often located under rubber feet or strips)
* Disconnect the internal battery
------------
-
-**Prepping to Flash**
+### Prepping to Flash
Most any 64-bit Debian/Ubuntu based distro should work here, but this guide will use a Ubuntu 23.04 live session booted from USB (since its version of flashrom supports Suzy-Q flashing).
-
Let's get to it:
1. Boot your Linux environment (Ubuntu 23.04 live USB or later recommended)
2. Connect to the internet
@@ -225,9 +208,7 @@ Let's get to it:
{: .note }
If you're not sure which file to use for your device / don't know your device's board name, you can reference [the supported devices page](supported-device.html).
------------
-
-**Persisting the board's Vital Product Data (VPD)**
+### Persisting the board's Vital Product Data (VPD)
The firmware in all ChromeOS devices contains a section (RO_VPD) which stores board-specific data, like the serial number, localization settings, and on many devices which have an Ethernet port, the LAN MAC address as well. When flashing via the Firmware Utility Script, the script will automatically extract this from the running firmware and inject it into the firmware to be flashed, so the device serial, LAN MAC address, etc are all maintained. Without this, the device will use a default/generic LAN MAC address set by coreboot. While not ideal, this is only really an issue if two or more of the same device are on the same LAN segment (or you're statically assigning IP addresses based on MAC). But for completeness, if flashing the UEFI firmware or shellball ROM, we'll extract the VPD (either from the board itself or a backup made by the script) and inject it into the firmware to be flashed.
@@ -246,9 +227,7 @@ You don't need to do this if flashing a stock firmware backup created by the Fir
Now the firmware image is ready to be flashed, and will maintain the device's unique serial, LAN MAC address, etc.
------------
-
-**Flashing Your Device**
+### Flashing Your Device**
Now that everything is prepped, time to flash the device.
@@ -259,12 +238,10 @@ Now that everything is prepped, time to flash the device.
* `sudo flashrom -p raiden_debug_spi:target=AP -w `
* Where is the name of your backup file, UEFI firmware file, or shellball firmware file. This will usually take 3-5 mins to complete; flashrom will first read the flash chip, determine which sectors differ, erase those sectors, write the new data, then verify the data written. The initial CCD setup make take a minute or so and not show any progress.
------------
-
-**Clean Up**
+### Clean Up
Once flashing is complete, disconnect the Suzy-Q cable. If the internal battery was not disconnected, the device will likely reboot as soon as flashing has completed. If the internal battery was disconnected, reconnect it and replace the bottom cover. Flip over the device, connect external power, press the power button, and cross your fingers :)
------------
+---
Adapted from https://wiki.mrchromebox.tech/Unbricking
diff --git a/docs/updating-firmware.md b/docs/updating-firmware.md
index 5cfe8495..6a657343 100644
--- a/docs/updating-firmware.md
+++ b/docs/updating-firmware.md
@@ -4,7 +4,12 @@ layout: default
nav_order: 17
---
-### Updating Custom Firmware
+# Updating Custom Firmware
+
+
+
+
+## Steps
1. If you have Windows installed, boot a Linux live ISO and connect to the internet. If you already have Linux installed, move on to step 2.
diff --git a/docs/ventoy.md b/docs/ventoy.md
index 8d983bf0..f3b37ac5 100644
--- a/docs/ventoy.md
+++ b/docs/ventoy.md
@@ -4,21 +4,22 @@ layout: default
nav_order: 26
---
-
-## Installing Ventoy to a USB drive in chromeOS
+# Installing Ventoy to a USB drive in chromeOS
Ventoy is a useful tool that allows you to have multiple OS installer images on a single drive. It is also the only way to properly create an installer for Windows using chromeOS.
-### Backing up your drive
+
+
+## Backing up your drive
Before we begin, be sure to backup any data that may be on your USB drive as it will be erased during this process.
-### Downloading Ventoy
+## Downloading Ventoy
Grab the latest Ventoy release from [GitHub](https://github.com/ventoy/Ventoy/releases). Be sure to get the Linux version.
-### Extracting Ventoy
+## Extracting Ventoy
Open VT-2 by pressing `Ctrl` + `Alt` + `F2` (Right arrow/Refresh) and run the following commands as root:
1. `cd /usr/local`
@@ -32,7 +33,7 @@ You can then run `ls` to verify you have the correct files, it should look somet
-### Starting Ventoy
+## Starting Ventoy
Run the following command to start the Ventoy Web GUI:
* `./VentoyWeb.sh`
@@ -42,14 +43,14 @@ You should see this on your screen now
-### Installing Ventoy
+## Installing Ventoy
Plug in your USB drive and click the green circle to refresh devices. You should see your USB drive get detected. Now click options, then Partition Style, then choose GPT.
Once you have done that and your drive is detected, click on Install and click Ok twice when prompted and again once the installation has completed. Once installation is complete, unplug and plug back in your USB drive.
-### Adding OS images
+## Adding OS images
Download an image of any OS you want. For Windows we recommend that you only use official ISOs from Microsoft.
Open Files and click on your USB drive, you should then see a device named "Ventoy".
| |