From d36cf981fe736c26f5eb14036d11fb8242a41418 Mon Sep 17 00:00:00 2001 From: Tim Crawford Date: Mon, 7 Jun 2021 11:29:30 -0600 Subject: [PATCH] readme: Expand "dependencies" to "quickstart" Give the process from 0 to built. Due to the implications of doing something wrong (unbootable machine), flashing is kept separate. Signed-off-by: Tim Crawford --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6fb955d..088bbca 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ laptops. - [Creating a custom keyboard layout](./doc/keyboard-layout-customization.md) - [Adding a new board](./doc/adding-a-new-board.md) -## Dependencies +## Quickstart -Install dependencies using the provided script: +Install dependencies using the provided script. -``` +```sh ./scripts/deps.sh ``` @@ -23,10 +23,18 @@ If rustup was installed as part of this, then the correct `cargo` will not be available in the running session. Start a new shell session or source the env file to update `PATH`. -``` +```sh source $HOME/.cargo/env ``` +Then build the firmware for your laptop model. + +```sh +make BOARD=system76/ +``` + +See [Flashing](./doc/flashing.md) for how to use the new firmware image. + ## Releases The EC firmware itself does not have tagged releases. Any commit of this repo