From a786e1d0e16bbab09501e7bc07e08b811610838e Mon Sep 17 00:00:00 2001 From: Ingo Reitz <9l@9lo.re> Date: Wed, 10 Jul 2024 20:07:27 +0200 Subject: [PATCH] more markdown fixes --- .github/workflows/md.yml | 2 +- README.md | 4 ++-- src/docs/installing/index.md | 12 +++++----- src/docs/installing/installing-windows.md | 28 +++++++++++------------ src/docs/unbricking/index.md | 1 - supported-devices/template.md | 10 ++++---- 6 files changed, 29 insertions(+), 28 deletions(-) diff --git a/.github/workflows/md.yml b/.github/workflows/md.yml index a54dc1e1..6e60c347 100644 --- a/.github/workflows/md.yml +++ b/.github/workflows/md.yml @@ -11,6 +11,6 @@ jobs: - uses: DavidAnson/markdownlint-cli2-action@v16 id: linter with: - globs: 'src/**/*.md' + globs: '**/*.md' config: '.markdownlint.jsonc' fix: true diff --git a/README.md b/README.md index 7510c491..4146a850 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -## Chrultrabook Docs -Centralized project documentation +# Chrultrabook Docs +Centralized project documentation diff --git a/src/docs/installing/index.md b/src/docs/installing/index.md index 0a89a8ed..42d7977d 100644 --- a/src/docs/installing/index.md +++ b/src/docs/installing/index.md @@ -11,13 +11,13 @@ Be sure to check the [supported devices page](../firmware/supported-devices.md) ## Windows -### Pros +### Pros of Windows - Works on most platforms with minimal tweaking¹ - Generally has better application support - Better game support -### Cons +### Cons of Windows - Audio driver is paid (10 USD) for Skylake (6th generation) and newer devices - USB4/Thunderbolt driver is paid (20 USD) for **TigerLake** (11th generation Intel processors) and **newer** generations on devices that require them @@ -32,13 +32,13 @@ Be sure to check the [supported devices page](../firmware/supported-devices.md) ## Linux -### Pros +### Pros of Linux - Free audio support - Lightweight and optimal for Chrultrabooks with low storage / slow CPUs - Most hardware (biggest exception is audio) will work out of the box -### Cons +### Cons of Linux - Potentially difficult for a new user (depending on the distro of choice) - Requires some work on the end user (running audio script, configuring keyboard mapping) @@ -54,11 +54,11 @@ Be sure to check the [supported devices page](../firmware/supported-devices.md) ## macOS -### Pros +### Pros of macOS - OS experience is near identical to a Mac -### Cons +### Cons of macOS - Battery life is subpar - Hardware based DRM (e.g AppleTV.app) is broken diff --git a/src/docs/installing/installing-windows.md b/src/docs/installing/installing-windows.md index d0d52e23..1405b437 100644 --- a/src/docs/installing/installing-windows.md +++ b/src/docs/installing/installing-windows.md @@ -55,21 +55,21 @@ Please see [CoolStar's driver portal](https://coolstar.org/chromebook/driverlice | CPU Generation | Paid Drivers | Notes | | ------------------ | ------------ | ----------------------------------------------------------------------------- | -| **Sandybridge** | n/a | -| **Ivybridge** | n/a | -| **Haswell** | n/a | -| **Broadwell** | n/a | -| **Baytrail** | n/a | -| **Braswell** | n/a | +| **Sandybridge** | n/a | | +| **Ivybridge** | n/a | | +| **Haswell** | n/a | | +| **Broadwell** | n/a | | +| **Baytrail** | n/a | | +| **Braswell** | n/a | | | **Skylake** | AVS | Models with a Celeron, Pentium, i3 or m3 CPU are eligible for a AUE discount. | | **Apollo Lake** | AVS or SOF | Can use either SOF or AVS | -| **Kaby Lake** | AVS | -| **Amber Lake** | AVS | -| **Gemini Lake** | SOF | -| **Comet Lake** | SOF | -| **Picasso / Dali** | n/a | +| **Kaby Lake** | AVS | | +| **Amber Lake** | AVS | | +| **Gemini Lake** | SOF | | +| **Comet Lake** | SOF | | +| **Picasso / Dali** | n/a | | | **Tiger Lake** | SOF, TB4 | TB4 and SOF can be purchased as a bundle. | -| **Jasper Lake** | SOF | +| **Jasper Lake** | SOF | | | **Alder Lake** | SOF, TB4 | TB4 and SOF can be purchased as a bundle. | -| **Cezanne** | SOF | -| **Mendocino** | SOF | +| **Cezanne** | SOF | | +| **Mendocino** | SOF | | diff --git a/src/docs/unbricking/index.md b/src/docs/unbricking/index.md index 8f227c7f..53793a06 100644 --- a/src/docs/unbricking/index.md +++ b/src/docs/unbricking/index.md @@ -11,7 +11,6 @@ If your device's firmware got into a bad state (will not POST), you can try unbr Try performing a EC reset beforehand to see if your device can recover. ::: - ::: tip If your device has a Ti50 chip and you didn't disable RO verification before flashing, follow [this guide](../firmware/ti50-ap-ro.md#recovering-a-device-bricked-due-to-ro-verification) to recover it. ::: diff --git a/supported-devices/template.md b/supported-devices/template.md index c87412ff..ed5cdebd 100644 --- a/supported-devices/template.md +++ b/supported-devices/template.md @@ -8,12 +8,14 @@ NOTE - do not edit the supported-devices.md file, edit the template file in the --> # Supported Devices and Platforms -Supported devices are listed in the table below, grouped by platform/family. If your device is not listed, it is not supported. Support is determined entirely and exclusively by the boardname. Use your Chromebook's boardname to see if it has support. + +Supported devices are listed in the table below, grouped by platform/family. If your device is not listed, it is not supported. Support is determined entirely and exclusively by the boardname. Use your Chromebook's boardname to see if it has support. ## Determining Device Support + What's in a name? All ChromeOS devices have a board/device name, which determines which firmware, OS build, etc a device uses. The board name is listed at the bottom of both the Recovery Mode and Developer Mode screens, as part of the hardware ID (HWID). -The chart below provides a full list of all ChromeOS devices currently supported by MrChromebox's Firmware Utility Script, the firmware types available for each, the hardware write-protect method used, and notes for Windows, Linux, and macOS operating systems. +The chart below provides a full list of all ChromeOS devices currently supported by MrChromebox's Firmware Utility Script, the firmware types available for each, the hardware write-protect method used, and notes for Windows, Linux, and macOS operating systems. In most cases, all of the devices in a given platform/family are supported, but sometimes there are exceptions (especially with older or newer devices). The goal is to offer both RW_LEGACY and UEFI Full ROM firmware for all devices, so you may have the option of dual booting ChromeOS, or liberating your device completely :) @@ -25,8 +27,8 @@ A device having firmware available (either RW_LEGACY or UEFI Full ROM) does not ## Supported Platforms -| Intel | AMD | ARM | -| - | - | - | +| Intel | AMD | ARM | +| ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Intel platforms have good support for both Linux and Windows. Some have support for macOS. | Stoneyridge support in Windows is questionable, and installing a custom kernel is required to get working audio in Linux. Ryzen has support for both Linux and Windows. MacOS is **untested** on AMD platforms. | Currently unsupported by the Chrultrabook dev team. [PostmarketOS](https://wiki.postmarketos.org/wiki/Chrome_OS_devices) has support for a few ARM Chromebooks. | ## Firmware and OS Support