Skip to content

sebanc/brunch

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

License Issues Discord Reddit Telegram

Logo

Brunch Framework

Special Thanks

First of all, thanks goes to Project Croissant, the swtpm maintainer, the Linux-Surface crew and the Chromebrew framework for their work which was actively used when creating this project.

About This Project

The purpose of the Brunch framework is to create a generic x86_64 ChromeOS image from an official recovery image. To do so, it uses a 1GB ROOTC partition (containing a custom kernel, an initramfs, the swtpm binaries, userspace patches and config files) and a specific EFI partition to boot from it.

Warning: Brunch is not the intended way for ChromeOS to work, at some point ChromeOS could potentially become incompatible with Brunch and delete data unexpectedly (even on non-ChromeOS partitions). By installing Brunch you agree to take those risks and I cannot be held responsible for anything bad that would happen to your device including data loss. It is therefore highly recommended to only use this framework on a device which does not contain any sensitive data and to keep non-sensitive data synced with a cloud service.

Supported Hardware

Hardware support is highly dependent on the general Linux kernel hardware compatibility. As such only Linux supported hardware will work and the same specific kernel command line options recommended for your device should be passed through the Grub bootloader (see "Modify the Grub bootloader" section). Some features such as camera, microphone and touchpad may not work or may require troubleshooting to get working.

Base Requirements:

  • x86_64 based computer with UEFI boot support.
    • MBR/Legacy devices may be supported with the MBR patch
  • Administrative privileges on the device.
  • An entry level understanding of the linux terminal.
    • This guide aims to make this process as easy as possible, but knowing the basics is expected.

CPU Compatibility:

Unsupported Hardware:

  • dGPUs are not supported
  • Virtual Machines are not supported
  • ARM CPUs are not supported
  • Intel Core 2 Duo and older are not supported

Install Instructions

This guide has been split into seperate sections, please follow one of the links below for a guide suitable to your current operating system.

Install with Linux Install with Linux

Install with Windows Install with Windows

Troubleshooting and Support

In case you run into issues while installing or using Brunch, below are the main places where you can find support:

Discord Reddit Telegram

Additional troubleshooting and support tips can be found at the following page:

Troubleshooting Troubleshooting and Support

About

Boot ChromeOS on x86_64 PC (supports most Intel CPU/GPU or AMD Ryzen / Stoney Ridge)

Resources

License

Stars

Watchers

Forks