Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Commit

Permalink
Update docs and (finally) implement/fix #168
Browse files Browse the repository at this point in the history
  • Loading branch information
MilkyDeveloper committed May 31, 2022
1 parent 6384ea2 commit 405c880
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
6 changes: 5 additions & 1 deletion bin/install-ectool
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ set -xe

echo "Downloading dependencies..."
git clone https://chromium.googlesource.com/chromiumos/platform/ec --depth 1
sudo apt update; sudo apt install git libftdi-dev libusb-dev libncurses5-dev pkgconf -y
sed -i -e 's/<libusb.h>/<libusb-1.0/libusb.h>/g' /tmp/file.txt
sudo apt update; sudo apt install git libftdi-dev libusb-dev libusb-1.0-0-dev libncurses5-dev pkgconf -y

echo "Compiling ectool..."
cd ec
Expand All @@ -15,3 +16,6 @@ echo
read BOARD
make BOARD=$BOARD CROSS_COMPILE= HOST_CROSS_COMPILE= build/$BOARD/util/ectool || echo "Compiling error or invalid board supplied."

sudo make install
echo "Done! Try this to set your fans to 100 percent:"
echo "ectool fanduty 100"
19 changes: 17 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Due to licensing restraints, you cannot just download an ISO of Breath and flash
2. ```
FEATURES=ISO,KEYMAP bash setup.sh cli ubuntu
```
This command should take around 30 minutes.
This command should take around 30cx minutes.

If you **don't want a minimal environment without a desktop** or **are running Crostini**, don't run the command and read below.

Expand Down Expand Up @@ -139,12 +139,27 @@ Once booted into Breath run the command depending on your device's board:

If audo still doesn't work, that's completely fine! Open up a Github Issue with your Chromebook model and I'll get audio working.

> ### Skylake (SKL) / Kabylake (KBL) disclaimer
> #### Skylake (SKL) / Kabylake (KBL) disclaimer
>
> If you have a Skylake or Kabylake device, do not change the UCM files (`/usr/share/alsa/ucm2/`) in an attempt to use PulseAudio. If you have no idea what any of these are, you can safely ignore this.
>
> PulseAudio, without UCM modifications, errors out. If you modify the UCM to remove the `Front Mic`, `Rear Mic`, and `Mic` (all of these are related to PCM3 on `da7219max`), PulseAudio and general audio will work, but your speakers **will be fried** or their membranes **will burst**.
### Goodies

**ZRAM:**
https://github.com/cb-linux/breath/issues/204#issuecomment-1133802766

**Fan Control/ectool:**
https://github.com/cb-linux/breath/issues/168#issuecomment-1142534066

**Audio Jack and Mic Testing:**
https://github.com/cb-linux/breath/discussions/190

## OpenCollective Page

If you find this useful, consider donating. Since I'm only a student, acquiring the resources to expand this project is only possible [with your support 💚](https://opencollective.com/breath)

## Doesn't work? That's expected!

Breath uses the exact ChromeOS Linux kernel. In other words, if the thing not working in Breath works in ChromeOS, it's a toggle away on my side. Just provide details like your **exact** Chromebook model name and your board name (shown on the bottom of the dev mode screen) and make a Github Issue. When you help me add support to your device, chances are a few more devices will become supported too!
Expand Down

0 comments on commit 405c880

Please sign in to comment.