From 57a60fd7285074dcf6205821382814cc18c535bb Mon Sep 17 00:00:00 2001 From: Tim Crawford Date: Tue, 4 Aug 2020 21:49:14 -0600 Subject: [PATCH] readme: Rewrite info for supported models/schematics --- README.md | 28 +++++++++++++++++++++++++--- README.md.in | 28 +++++++++++++++++++++++++--- 2 files changed, 50 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7cbec4f..aa6c3f3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,32 @@ # System76 Open Firmware -An open source distribution of firmware utilizing coreboot, EDK2, and System76 firmware applications. +An open source distribution of firmware utilizing coreboot, EDK2, and System76 +firmware applications. -Please note that only the darp6, galp4, lemp9, oryp6 models are officially supported - if you brick your device it will be up to you to restore the current firmware using an external programmer. +## Supported models -If you would like to view schematics for any supported System76 model, please send 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. +These models are supported and will receive updates through the firmware +manager: + +- bonw14 +- darp6 +- galp4 +- lemp9 +- oryp6 + +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. + +### Schematics + +Board schematics can be provided on request 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. + +You may not share these without explicit permission from System76. ## Dependencies diff --git a/README.md.in b/README.md.in index 90331e3..bd719d9 100644 --- a/README.md.in +++ b/README.md.in @@ -1,10 +1,32 @@ # System76 Open Firmware -An open source distribution of firmware utilizing coreboot, EDK2, and System76 firmware applications. +An open source distribution of firmware utilizing coreboot, EDK2, and System76 +firmware applications. -Please note that only the darp6, galp4, lemp9, oryp6 models are officially supported - if you brick your device it will be up to you to restore the current firmware using an external programmer. +## Supported models -If you would like to view schematics for any supported System76 model, please send 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. +These models are supported and will receive updates through the firmware +manager: + +- bonw14 +- darp6 +- galp4 +- lemp9 +- oryp6 + +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. + +### Schematics + +Board schematics can be provided on request 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. + +You may not share these without explicit permission from System76. ## Dependencies