7888f214bb
People who are just reading the keyboard customization instructions might overread the dependencies installations sections. Additionally, installing rustup for the first time requires sourcing cargo's env vars in case the firmware is flashed in the same shell session after installing rustup.
27 lines
745 B
Markdown
27 lines
745 B
Markdown
# System76 EC
|
|
|
|
System76 EC is a GPLv3 licensed embedded controller firmware for System76
|
|
laptops.
|
|
|
|
## Documentation
|
|
|
|
- [Supported embedded controllers](./doc/controllers.md)
|
|
- [Flashing firmware](./doc/flashing.md)
|
|
- [Debugging](./doc/debugging.md)
|
|
- [Creating a custom keyboard layout](./doc/keyboard-layout-customization.md)
|
|
- [Adding a new board](./doc/adding-a-new-board.md)
|
|
|
|
## Dependencies
|
|
|
|
Install dependencies using the provided script:
|
|
|
|
```
|
|
./scripts/deps.sh
|
|
```
|
|
|
|
The dependencies include `rustup` - if it wasn't installed on your system before and you plan to flash the firmware within the same shell session, you should additionally source the environment variables for cargo to avoid build failures:
|
|
|
|
```
|
|
source $HOME/.cargo/env
|
|
```
|