diff --git a/README.md b/README.md index 87fb6c4..286ebe6 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,14 @@ manager: - addw2 - bonw14 -- darp5 - darp6 - darp7 -- galp3-c - galp4 - galp5 - gaze15 - gaze16-3050 - gaze16-3060 +- gaze16-3060-b - lemp9 - lemp10 - oryp6 @@ -31,19 +30,19 @@ seen in the `models/` directory. If the device becomes bricked it will require restoring the current firmware using an external programmer. See [flashing](./docs/flashing.md) for details. +### Schematics + +System76 customers may request board schematics for their system by sending an +email to firmware@system76.com with the subject line "Schematics for _model_", +where _model_ is one of the supported models listed above. Please include the +serial number of your system for verification. + +You may not share these without explicit permission from System76. + ## Changelog For a list of important changes please see the [changelog](./CHANGELOG.md). -## Schematics - -System76 customers may request board schematics by sending an email to -firmware@system76.com with the subject line "Schematics for _model_", where -_model_ is the name of a directory in the `models/` directory, such as darp6. -Please include the serial number of your system for verification. - -You may not share these without explicit permission from System76. - ## Dependencies ### Install toolchain @@ -65,18 +64,3 @@ source ~/.cargo/env ``` ./scripts/qemu.sh ``` - -## Contents - -- [apps](./apps) - Applications -- [coreboot](https://github.com/system76/coreboot.git) - coreboot README -- [docs](./docs) - System76 Open Firmware Documentation -- [ec](https://github.com/system76/ec.git) - System76 EC -- [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) - This branch holds all platforms actively maintained against the -- [FSP](https://github.com/IntelFsp/FSP.git) - IntelĀ® Firmware Support Package (IntelĀ® FSP) Binaries -- [libs](./libs) - Libraries -- [models](./models) - Models -- [scripts](./scripts) -- [tools](./tools) - Tools diff --git a/README.md.in b/README.md.in deleted file mode 100644 index 427e8fa..0000000 --- a/README.md.in +++ /dev/null @@ -1,64 +0,0 @@ -# System76 Open Firmware - -An open source distribution of firmware utilizing coreboot, EDK2, and System76 -firmware applications. - -## Supported models - -These models are supported and will receive updates through the firmware -manager: - -- addw2 -- bonw14 -- darp5 -- darp6 -- darp7 -- galp3-c -- galp4 -- galp5 -- gaze15 -- lemp9 -- lemp10 -- oryp6 -- oryp7 - -Other models may be in development or available without support, and can be -seen in the `models/` directory. - -If the device becomes bricked it will require restoring the current firmware -using an external programmer. See [flashing](./docs/flashing.md) for details. - -## Changelog - -For a list of important changes please see the [changelog](./CHANGELOG.md). - -## Schematics - -System76 customers may request board schematics by sending an email to -firmware@system76.com with the subject line "Schematics for _model_", where -_model_ is the name of a directory in the `models/` directory, such as darp6. -Please include the serial number of your system for verification. - -You may not share these without explicit permission from System76. - -## Dependencies - -### Install toolchain -``` -./scripts/deps.sh -``` - -### Load Rust environment (or optionally reboot) -``` -source ~/.cargo/env -``` - -### Build firmware, replace qemu with your model (look in the models directory for examples) -``` -./scripts/build.sh qemu -``` - -### Emulate firmware, only available after building the qemu model -``` -./scripts/qemu.sh -``` diff --git a/scripts/readmes.sh b/scripts/readmes.sh index 46707da..75caef5 100755 --- a/scripts/readmes.sh +++ b/scripts/readmes.sh @@ -5,7 +5,6 @@ README_DIRS=( libs models tools - . ) set -e @@ -20,9 +19,7 @@ function readme_model { pushd "$1" > /dev/null cp README.md.in README.md - echo >> README.md - echo "## Contents" >> README.md - echo >> README.md + echo -e "\n## Contents\n" >> README.md "$MODELTOOL" . >> README.md popd > /dev/null } @@ -63,9 +60,7 @@ function readme_dir { pushd "$1" > /dev/null cp README.md.in README.md - echo >> README.md - echo "## Contents" >> README.md - echo >> README.md + echo -e "\n## Contents\n" >> README.md for dir in */ do if ! git check-ignore --quiet "${dir}"