Update README.md

This commit is contained in:
Jeremy Soller
2019-10-09 18:55:55 -06:00
committed by GitHub
parent d35ef89f9c
commit c60072e937

View File

@@ -1,35 +1,35 @@
# firmware-open # firmware-open
System76 Open Source Firmware System76 Open Firmware
## Dependencies ## Dependencies
### Install toolchain ### Install toolchain
``` ```
./scripts/deps.sh ./scripts/deps.sh
``` ```
### Load Rust environment (or optionally reboot) ### Load Rust environment (or optionally reboot)
``` ```
source ~/.cargo/env source ~/.cargo/env
``` ```
### Build firmware, replace darp5 with your model (look in the models directory for examples) ### Build firmware, replace darp5 with your model (look in the models directory for examples)
``` ```
./scripts/build.sh darp5 ./scripts/build.sh darp5
``` ```
### Flashing firmware manually is not recommended for the normal user. For the advanced user, there is a script flash.sh which takes the same arguments as build.sh ### Flashing firmware manually is not recommended for the normal user. For the advanced user, there is a script flash.sh which takes the same arguments as build.sh
## Contents ## Contents
- [apps](./apps) - Applications - [apps](./apps) - Applications
- [coreboot](https://github.com/system76/coreboot.git) - coreboot README - [coreboot](https://github.com/system76/coreboot.git) - coreboot README
- [edk2](https://github.com/system76/edk2.git) - EDK II Project - [edk2](https://github.com/system76/edk2.git) - EDK II Project
- [edk2-non-osi](https://github.com/tianocore/edk2-non-osi.git) - [edk2-non-osi](https://github.com/tianocore/edk2-non-osi.git)
- [edk2-platforms](https://github.com/system76/edk2-platforms.git) - This branch holds all platforms actively maintained against the - [edk2-platforms](https://github.com/system76/edk2-platforms.git) - This branch holds all platforms actively maintained against the
- [FSP](https://github.com/IntelFsp/FSP.git) - Intel® Firmware Support Package (Intel® FSP) Binaries - [FSP](https://github.com/IntelFsp/FSP.git) - Intel® Firmware Support Package (Intel® FSP) Binaries
- [libs](./libs) - Libraries - [libs](./libs) - Libraries
- [models](./models) - Models - [models](./models) - Models
- [scripts](./scripts) - [scripts](./scripts)
- [tools](./tools) - Tools - [tools](./tools) - Tools