sravan/system76-embedded-controller
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme: Expand "dependencies" to "quickstart"

Browse Source 
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 <tcrawford@system76.com>
This commit is contained in:
Tim Crawford 2021-06-07 11:29:30 -06:00 committed by Jeremy Soller
parent ca09e86987
commit d36cf981fe
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -11,11 +11,11 @@ laptops.
- [Creating a custom keyboard layout](./doc/keyboard-layout-customization.md) - [Creating a custom keyboard layout](./doc/keyboard-layout-customization.md)
- [Adding a new board](./doc/adding-a-new-board.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 ./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 available in the running session. Start a new shell session or source the env
file to update `PATH`. file to update `PATH`.
``` ```sh
source $HOME/.cargo/env source $HOME/.cargo/env
``` ```
Then build the firmware for your laptop model.
```sh
make BOARD=system76/<model>
```
See [Flashing](./doc/flashing.md) for how to use the new firmware image.
## Releases ## Releases
The EC firmware itself does not have tagged releases. Any commit of this repo The EC firmware itself does not have tagged releases. Any commit of this repo