diff --git a/README.md b/README.md index 013635c..7da68b2 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,49 @@ System76 Open Source Firmware +## Dependencies + +### Install toolchain +``` +sudo apt-get install \ + build-essential \ + bison \ + ccache \ + flex \ + git-lfs \ + gnat \ + mtools \ + nasm \ + uuid-dev +``` + +### Install rust nightly +``` +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly +``` + +### Load cargo environment (or optionally reboot) +``` +source ~/.cargo/env +``` + +### Install cargo-xbuild +``` +cargo install cargo-xbuild +``` + +### Build firmware, replace darp5 with your model (look in the models directory for examples) +``` +./scripts/build.sh darp5 +``` + ## Contents - [apps](./apps) - Applications - [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-platforms](https://github.com/system76/edk2-platforms.git) - **EDK II Minimum Platform Firmware for Intel(R) Platforms** +- [edk2-platforms](https://github.com/system76/edk2-platforms.git) - **EDK II Minimum Platform Firmware for Intel(R) Platforms** - [FSP](https://github.com/IntelFsp/FSP.git) - IntelĀ® Firmware Support Package (IntelĀ® FSP) Binaries - [libs](./libs) - Libraries - [models](./models) - Models diff --git a/README.md.in b/README.md.in index ce606b3..e9bb4b9 100644 --- a/README.md.in +++ b/README.md.in @@ -1,3 +1,39 @@ # firmware-open System76 Open Source Firmware + +## Dependencies + +### Install toolchain +``` +sudo apt-get install \ + build-essential \ + bison \ + ccache \ + flex \ + git-lfs \ + gnat \ + mtools \ + nasm \ + uuid-dev +``` + +### Install rust nightly +``` +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly +``` + +### Load cargo environment (or optionally reboot) +``` +source ~/.cargo/env +``` + +### Install cargo-xbuild +``` +cargo install cargo-xbuild +``` + +### Build firmware, replace darp5 with your model (look in the models directory for examples) +``` +./scripts/build.sh darp5 +``` diff --git a/models/README.md b/models/README.md index 8070dac..5a3f0a3 100644 --- a/models/README.md +++ b/models/README.md @@ -2,11 +2,14 @@ ## Contents +- [addp1](./addp1) - System76 Adder Pro (addp1) - [darp5](./darp5) - System76 Darter Pro (darp5) - [galp2](./galp2) - System76 Galago Pro (galp2) - [galp3](./galp3) - System76 Galago Pro (galp3) - [galp3-b](./galp3-b) - System76 Galago Pro (galp3-b) - [galp3-c](./galp3-c) - System76 Galago Pro (galp3-c) - [gaze14_1650_15](./gaze14_1650_15) - System76 Gazelle (gaze14) +- [gaze14_1650_17](./gaze14_1650_17) - System76 Gazelle (gaze14) - [gaze14_1660ti_15](./gaze14_1660ti_15) - System76 Gazelle (gaze14) +- [gaze14_1660ti_17](./gaze14_1660ti_17) - System76 Gazelle (gaze14) - [thelio-b1](./thelio-b1) - System76 Thelio (thelio-b1) diff --git a/models/addp1/README.md b/models/addp1/README.md new file mode 100644 index 0000000..35f0e07 --- /dev/null +++ b/models/addp1/README.md @@ -0,0 +1,12 @@ +# System76 Adder Pro (addp1) + +https://system76.com/guides/addp1 + +## Contents + +- [EC](./ec.rom) + - *Read Error: No such file or directory (os error 2)* +- [FD](./fd.rom) + - *Read Error: No such file or directory (os error 2)* +- [ME](./me.rom) + - *Read Error: No such file or directory (os error 2)* diff --git a/models/addp1/README.md.in b/models/addp1/README.md.in new file mode 100644 index 0000000..4154ae0 --- /dev/null +++ b/models/addp1/README.md.in @@ -0,0 +1,3 @@ +# System76 Adder Pro (addp1) + +https://system76.com/guides/addp1 diff --git a/models/gaze14_1650_17/README.md b/models/gaze14_1650_17/README.md new file mode 100644 index 0000000..4ed6e9a --- /dev/null +++ b/models/gaze14_1650_17/README.md @@ -0,0 +1,12 @@ +# System76 Gazelle (gaze14) + +https://system76.com/guides/gaze14 + +## Contents + +- [EC](./ec.rom) + - *Read Error: No such file or directory (os error 2)* +- [FD](./fd.rom) + - *Read Error: No such file or directory (os error 2)* +- [ME](./me.rom) + - *Read Error: No such file or directory (os error 2)* diff --git a/models/gaze14_1650_17/README.md.in b/models/gaze14_1650_17/README.md.in new file mode 100644 index 0000000..a111029 --- /dev/null +++ b/models/gaze14_1650_17/README.md.in @@ -0,0 +1,3 @@ +# System76 Gazelle (gaze14) + +https://system76.com/guides/gaze14 diff --git a/models/gaze14_1660ti_17/README.md b/models/gaze14_1660ti_17/README.md new file mode 100644 index 0000000..4ed6e9a --- /dev/null +++ b/models/gaze14_1660ti_17/README.md @@ -0,0 +1,12 @@ +# System76 Gazelle (gaze14) + +https://system76.com/guides/gaze14 + +## Contents + +- [EC](./ec.rom) + - *Read Error: No such file or directory (os error 2)* +- [FD](./fd.rom) + - *Read Error: No such file or directory (os error 2)* +- [ME](./me.rom) + - *Read Error: No such file or directory (os error 2)* diff --git a/models/gaze14_1660ti_17/README.md.in b/models/gaze14_1660ti_17/README.md.in new file mode 100644 index 0000000..a111029 --- /dev/null +++ b/models/gaze14_1660ti_17/README.md.in @@ -0,0 +1,3 @@ +# System76 Gazelle (gaze14) + +https://system76.com/guides/gaze14