summaryrefslogtreecommitdiff
path: root/util/coreboot-configurator/README.md
diff options
context:
space:
mode:
authorSean Rhodes <sean@starlabs.systems>2021-11-12 08:54:50 +0000
committerMartin Roth <martinroth@google.com>2022-01-27 16:16:23 +0000
commit9c89e3ada2dd30d683c44364e8eea5de757b74eb (patch)
tree30e29cf5094559f82589dd7583aeac89c5a95592 /util/coreboot-configurator/README.md
parentaef6de34263694a62f42135be1a97075ec3a2b7a (diff)
util: Add coreboot-configurator
A simple GUI to change settings in coreboot's CBFS, via the nvramtool utility. Test on the StarBook Mk IV running coreboot 4.15 with: * Ubuntu 20.04 * Ubuntu 21.10 * MX Linux 21 * elementary OS 6 * Manjaro 21 Signed-off-by: Sean Rhodes <sean@starlabs.systems> Change-Id: I491922bf55ed87c2339897099634a38f8d055876 Reviewed-on: https://review.coreboot.org/c/coreboot/+/59256 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin Roth <martinroth@google.com>
Diffstat (limited to 'util/coreboot-configurator/README.md')
-rw-r--r--util/coreboot-configurator/README.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/util/coreboot-configurator/README.md b/util/coreboot-configurator/README.md
new file mode 100644
index 0000000000..baf04903b2
--- /dev/null
+++ b/util/coreboot-configurator/README.md
@@ -0,0 +1,65 @@
+# coreboot-configurator ![alt text](images/StarLabs_Logo.png "Star Labs Systems")
+
+A simple GUI to change settings in coreboot's CBFS, via the nvramtool utility.
+
+![coreboot-configurator](images/coreboot-configurator.gif)
+# How to install
+## Ubuntu, Linux Mint, elementary OS, Zorin OS and other derivates
+##### Install
+```
+sudo add-apt-repository ppa:starlabs/coreboot
+sudo apt update
+sudo apt install coreboot-configurator
+```
+##### Uninstall
+```
+sudo apt purge coreboot-configurator
+```
+
+## Debian 11
+##### Install
+```
+echo "deb http://ppa.launchpad.net/starlabs/ppa/ubuntu focal main" | sudo tee -a /etc/apt/sources.list.d/starlabs-ubuntu-ppa-focal.list
+sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 17A20BAF70BEC3904545ACFF8F21C26C794386E3
+sudo apt update
+sudo apt install coreboot-configurator
+```
+
+##### Uninstall
+```
+sudo apt purge coreboot-configurator
+```
+
+## Manjaro
+##### Install
+```
+sudo pamac install coreboot-configurator
+```
+##### Uninstall
+```
+sudo pamac remove coreboot-configurator
+```
+
+## Other Distributions
+##### Install
+```
+git clone https://github.com/StarLabsLtd/coreboot-configurator.git
+cd coreboot-configurator
+meson build
+ninja -C build install
+```
+##### Uninstall
+```
+sudo ninja -C uninstall
+```
+
+# Advanced Mode
+Enabling advanced mode will all you to see all settings contained inside coreboot. Tread carefully :)
+
+## Copying or Reusing
+Included scripts are free software licensed under the terms of the [GNU General Public License, version 2](https://www.gnu.org/licenses/gpl-2.0.txt).
+
+# [© Star Labs® / All Rights Reserved.](https://starlabs.systems)
+Any issues or questions, please contact us at [support@starlabs.systems](mailto:supportstarlabs.systems)
+
+View our full range of Linux laptops at: [https://starlabs.systems](https://starlabs.systems)