Skip to content

update docs/pixel-bringup.md for better readability #250

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

Open
wants to merge 1 commit into
base: 16
Choose a base branch
from
+4 −4
Open

update docs/pixel-bringup.md for better readability #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/pixel-bringup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The factory images ZIP will be saved in `~/stock_images`. Full OTA packages are

## 2. Create a config

Create a simple YAML config file to get started with your device. The [example config](../config/examples/device.yml) has detailed documentation for all possible config values, but this is the bare minimum you need to start:
Create a simple YAML config file to get started with your device. The [example config](https://github.com/kdrag0n/adevtool/blob/main/config/examples/device.yml) has detailed documentation for all possible config values, but this is the bare minimum you need to start:

```yaml
device:
Expand Down Expand Up @@ -59,7 +59,7 @@ m installclean
m
```

**The first build is expected to fail — don't panic.** Read the errors to determine which dependencies are missing and add the missing files to the `filters: dep_files` section of the config accordingly. See the [Pixel 2020](../config/pixel/snippets/2020.yml#L26) config for reference.
**The first build is expected to fail — don't panic.** Read the errors to determine which dependencies are missing and add the missing files to the `filters: dep_files` section of the config accordingly. See the [Pixel 2020](https://github.com/kdrag0n/adevtool/blob/main/config/pixel/snippets/2020.yml#L26) config for reference.

After adding the missing files, generate the vendor module again (step 2) and attempt another build. Repeat until the build completes successfully.

Expand Down Expand Up @@ -117,6 +117,6 @@ To fix features and improve the quality of your bringup, review the following ge
- SELinux policies and partitions: `proprietary/BoardConfigVendor.mk`
- System properties and built packages: `proprietary/device-vendor.mk`

Add filters and regenerate the module until everything looks good. It will be helpful to use [existing Pixel configs](../config/pixel) as references.
Add filters and regenerate the module until everything looks good. It will be helpful to use [existing Pixel configs](../config/device) as references.

If you get a new Pixel device working with no apparent bugs, congrats! Please consider contributing official support for the device [by making a pull request](https://github.com/kdrag0n/adevtool/compare).
If you get a new Pixel device working with no apparent bugs, congrats! Please consider contributing official support for the device [by making a pull request](https://github.com/GrapheneOS/adevtool/compare).