Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate firmware part of docs to MrChromebox's website #200

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Migrate firmware part of docs to MrChromebox's website #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8dcb355
faq.md: reorganize and remove duplicate questions
sadlerm4 Jul 17, 2024
de9bb5f
index.md: add title and remove separator before h2
sadlerm4 Jul 21, 2024
bc752a6
ventoy.md: simplify title, reminder to enable developer mode
sadlerm4 Jul 22, 2024
2695c5f
Move firmware/ventoy.md to installing/ventoy.md
sadlerm4 Jul 22, 2024
0a2ce65
config.js: fix json
sadlerm4 Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,6 @@ export default {
{
text: 'Flashing Manually',
link: '/docs/firmware/manually-flashing',
},
{
text: 'Installing Ventoy With chromeOS',
link: '/docs/firmware/ventoy'
}
]
},
Expand All @@ -139,6 +135,13 @@ export default {
{
text: 'Creating a Bootable USB',
link: '/docs/installing/bootableusb',
collapsible: true,
children: [
{
text: 'Using Ventoy on ChromeOS',
link: '/docs/installing/ventoy'
}
]
},
{
text: 'Installing Windows',
Expand Down
63 changes: 29 additions & 34 deletions src/docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,94 +4,89 @@
Please read this page before asking for help. Your help request will be pointed to the docs otherwise.
:::

::: tip
For questions related to MrChromebox firmware, please visit [https://docs.mrchromebox.tech/docs/faq.html]
:::

## General questions

### What OS should I use?

- This depends on your use case. Only you can answer this question. <!-- Not ubuntu plz -->

### Should I use rw-legacy or full rom?
### Why is your supported devices list different to MrChromebox's list?

- This depends on what you are looking to use your device for. If you are planning on installing Windows or macOS you need to use full rom. Rw-legacy only supports linux.
- MrChromebox only provides firmware support. A device having firmware available does not mean that it has Windows/Linux/macOS support. If your device has firmware support but no OS support, open a post on the [Chrultrabook Forum](https://forum.chrultrabook.com) and someone will try to help.

### My internal keyboard doesn't work, can I use an external keyboard to get into developer mode?
### Should I use RW_LEGACY or Full ROM MrChromebox firmware?

- No. The hotkeys will only work on the internal keyboard. Chromeboxes do not have this restriction.
- This depends on what you are looking to use your device for. If you are planning on installing Windows or macOS you need to use full ROM. RW_LEGACY only supports Linux.

### I just want to boot Linux from USB on my Chromebook, what do I need to do?
### My internal keyboard doesn't work, can I use an external keyboard to enable Developer Mode?

- Check the Supported Devices page, to ensure your device has functional RW_LEGACY firmware available. If so, flash RWL (RW_LEGACY firmware) and use that.
- No. The hotkeys will only work on the internal keyboard. Chromeboxes do not have this restriction.

### Can I disable power-on when I open my Chromebook?
### Can I disable auto power-on when I open my Chromebook lid?

- No. In what situation would you open your Chromebook without the intention of turning it on anyways.

### My Chromebook powers back on when I turn it off. How can I fix this?

- You Do not. Specific Chromebooks have this bug which takes too much effort to debug. If you were looking to disable power-on when you open the lid because of this, they are completely unrelated.

### I just installed the UEFI firmware, and now my device boots to a black screen that says 'shell' - what do I do?

- you are in the EFI shell; the firmware boots there when it can't find a valid UEFI boot device, either externally (USB, SD) or internally. Just type `exit` to get back to the the UEFI settings menu.
- It's a known issue. Specific Chromebooks have this bug which takes too much effort to debug. If you were looking to disable power-on when you open the lid because of this, they are two completely unrelated things.

### Should I install 32 or 64-bit OS?

- The UEFI Full ROM firmware only supports 64-bit OS, so be sure to use the 'x86_64' version of whatever OS you want to install. USB media created from 32-bit ISOs will simply fail to boot.

### I'm running Legacy boot firmware now - can I switch to the UEFI firmware?

- If you are using SeaBIOS, you will likely need to re-install your operating system. Otherwise it should work fine.

### Help! I can't exit Developer Mode

- If you are trying to exit Developer Mode but get the error `WARNING: TONORM prohibited by GBB_FORCE_DEV_SWITCH_ON` or find the `Return to secure mode` button missing, you need to reset your GBB flags. You can do that by running [MrChromebox's firmware utility script](https://mrchromebox.tech/#fwscript) and selecting `3) Set Boot Options (GBB flags)`, followed by `5) Reset to factory default`.
- Then exit developer mode by choosing "Return to secure mode" on the bootup screen
- The UEFI Full ROM firmware only supports 64-bit OSes, so be sure to use the 'x86_64' or 'amd64' version of whatever OS you want to install. USB media created from 32-bit ISOs will simply fail to boot.

### Can I modify the fan speed?

- Yes, using ectool. To set the fan to auto, run: `ectool autofanctrl`. To specify a percentage, run `ectool fanduty [0-100]`.
- Yes, using ectool. To set the fan to auto, run: `ectool autofanctrl`. To specify a percentage, run `ectool fanduty [0-100]`. You can find more info about ectool [here]().

Check failure on line 43 in src/docs/faq.md

View workflow job for this annotation

GitHub Actions / markdownlint-cli

No empty links 

src/docs/faq.md:43:164 MD042/no-empty-links No empty links [Context: "[here]()"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md042.md

### Can I overclock the fan?

- No.

### I want to buy a Chromebook to run Windows or Linux or macOS -- which should I buy?

- Any 64 bit Chromebook should work in Windows and Linux. Some require paid drivers (Windows only). For information on macOS requirements, see [this page](installing/installing-macos.md).
- Any 64-bit Chromebook up to Intel Core 13th gen (Raptor Lake) should work in Windows and Linux. We appreciate the community helping to test hardware, and your patience if not everything works immediately the way you expected it to. Some Chromebooks require paid audio drivers (Windows only). For information on macOS requirements, see [this page](installing/installing-macos.md).

### Are there any Chromebooks/Chromeboxes I should avoid buying/converting to a chrultrabook?

- Please check [https://docs.mrchromebox.tech/known-issues.html] for a list of firmware issues that affect some platforms. Then check any device-specific notes section in the [supported devices list](/firmware/supported-devices.html)

<br>

## Windows questions

### Should I use Windows 10 or 11?

- Windows 11 is required for TB4 users. If you Do not have Thunderbolt 4, you may use both 10 or 11.
- Windows 11 is required for TB4 users. If you do not have Thunderbolt 4, you may use either 10 or 11.

### Can I pay for Windows drivers using PayPal?

- You can pay via PayPal in Patreon.

### My balance shows zero on coolstars portal, what should I do?
### How do I buy/download/install the Windows audio/Thunderbolt drivers after I've subscribed on Patreon?

- It may take up to 48 hours for balance to appear in her portal, though it is normally less then 2.
- After logging into [CoolStar's driver portal](https://coolstar.org/chromebook/driverlicense/login.html) with your Patreon account, follow the instructions onscreen for a step by step tutorial.

### How do I buy the Windows audio/Thunderbolt drivers?
### My balance shows zero on CoolStar's portal, what should I do?

- Please see [CoolStar's driver portal](https://coolstar.org/chromebook/driverlicense/login.html) for a step by step tutorial on purchasing drivers.
- It may take up to 48 hours for the balance to be updated on the portal, though it is normally less than 2.

### Can I get AVS or SOF drivers for free?

- No. Only the Linux drivers are free.

### Why is there a license error in Device Manager after installing audio drivers?

- You messed up the license setup. Please refer to [CoolStar's driver portal](https://coolstar.org/chromebook/driverlicense/login.html).
- You messed up the license setup. Please refer to instructions on CoolStar's portal and the README contained within the files you downloaded when downloading the driver.

### Will the audio driver still work when re-installing Windows?

- Yes, on the device the license was created. If the internal drive was replaced, see below.

### I upgraded my Chromebooks' internal drive and my audio/Thunderbolt 4 license is not working, what do I do?
### I upgraded my Chromebook's internal drive and my audio/Thunderbolt 4 license is not working, what do I do?

- The license is tied to the serial number of your internal drive. **You do not need to buy another license**. Send CoolStar a message through Patreon, and wait for about a week.

Expand All @@ -113,11 +108,11 @@
- They have started to force snap on their users.
- They have published an LTS distro with a non-LTS kernel.

Becuse of these things, Ubuntu is unsupported. We will not help you fix issues on Ubuntu.
Becuse of these things, and the time and effort that would be required for the project to work around them, Ubuntu is unsupported. We will not help you fix issues on Ubuntu.

### What Linux distros are recommended?
### What Linux distros are recommended by the chrultrabook project?

- See [this page](installing/installing-linux.md).
- Fedora, Ultramarine Linux, Arch Linux and Debian.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading is hard for people.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True true, though the only issue is if one place gets updated and the other doesn't. Maybe add an html comment on the installing Linux page saying suggestions are also on this page

And to note, if both fedora and ultramine are noted here, both arch and endeavoros should be noted here. Otherwise ultramine seems a little out of place when we're noting the fedora based distro, but not the arch based distro. (I overcomplicated this comment)

Copy link
Contributor Author

@sadlerm4 sadlerm4 Jul 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep I see what you mean, also apparently the list itself may change...

I don't remember why EndeavourOS was added in the first place, I think maybe I based the original list off what distros the project members use? WeirdTreeThing used to use EndeavourOS on at least one Chromebook (maybe still does), elly uses Fedora, and MrChromebox uses Pop!_OS (afaik). Ultramarine is included because it's the target of a specific Chromebook edition.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its simply a list of whats proven to be reliably working

Copy link
Contributor Author

@sadlerm4 sadlerm4 Jul 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any contributors who use Tumbleweed on a Chromebook, or is it proven to be reliably working some other way?


### How can I get audio working under Linux?

Expand Down
10 changes: 7 additions & 3 deletions src/docs/firmware/ventoy.md → src/docs/installing/ventoy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing Ventoy to a USB drive with chromeOS
# Using Ventoy on 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.
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 the Windows installer using ChromeOS.

## Backing up your drive

Expand All @@ -16,6 +16,10 @@ Grab the latest Ventoy release from [GitHub](https://github.com/ventoy/Ventoy/re

## Extracting Ventoy

::: tip NOTE
You need to have already enabled Developer Mode first.
:::

Open VT-2 by pressing Ctrl + Alt + 🡢 (F2) and run the following commands as root:

1. `cd /usr/local`
Expand All @@ -36,7 +40,7 @@ Run the following command to start the Ventoy Web GUI:

- `./VentoyWeb.sh`

Next, switch back to VT-1 by pressing Ctrl + Alt + 🡠 (F1)and open `http://localhost:24680` in Chrome.
Next, switch back to VT-1 by pressing Ctrl + Alt + 🡠 (F1) and open `http://localhost:24680` in Chrome.

You should see this on your screen now:

Expand Down
3 changes: 1 addition & 2 deletions src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
home: true
title: Home
heroText: Welcome to the Chrultrabook Docs
tagline: Convert your Chromebook into an Ultrabook!
heroImage: /chrome.svg
Expand All @@ -14,12 +15,10 @@
</div>
---

# What is a chrultrabook and who is this documentation for?

Check failure on line 18 in src/index.md

View workflow job for this annotation

GitHub Actions / markdownlint-cli

Multiple top-level headings in the same document 

src/index.md:18 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# What is a chrultrabook and w..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md

A chrultrabook is a modified Chromebook that is able to run Windows, Linux, and sometimes macOS by using MrChromebox’s coreboot firmware. The purpose of this site is to provide documentation that is detailed, user-friendly, and has up-to-date information about the hardware, software, and firmware on Chromebooks.

---

## These docs focus on two main things

- Installing Windows/Linux/macOS on your Chromebook.
Expand Down
Loading