mirror of
https://codeberg.org/libreboot/lbmk.git
synced 2026-07-22 14:36:31 +02:00
Merge pull request 'Simplify the README' (#269) from runxiyu/lbmk:readme-simplification into master
Reviewed-on: https://codeberg.org/libreboot/lbmk/pulls/269
This commit is contained in:
Leah Rowe
@@ -1,123 +1,57 @@
|
|||||||
Libreboot
|
Libreboot
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Find libreboot documentation at <https://libreboot.org/>
|
Documentation: [libreboot.org](https://libreboot.org)\
|
||||||
|
Support: [\#libreboot](https://web.libera.chat/#libreboot) on
|
||||||
|
[Libera](https://libera.chat/) IRC
|
||||||
|
|
||||||
The `libreboot` project provides
|
Libreboot provides
|
||||||
[libre](https://libreboot.org/freedom-status.html) *boot
|
[libre](https://libreboot.org/freedom-status.html)
|
||||||
firmware* that initializes the hardware (e.g. memory controller, CPU,
|
boot firmware on
|
||||||
peripherals) on specific Intel/AMD x86 and ARM targets, which
|
[supported motherboards](https://libreboot.org/docs/install/#which-systems-are-supported-by-libreboot). It replaces proprietary vendor BIOS/UEFI implementations, by
|
||||||
then starts a bootloader for your operating system. Linux/BSD are
|
* Using coreboot to initialize the hardware (e.g. memory controller, CPU, etc.) while
|
||||||
well-supported. It replaces proprietary BIOS/UEFI firmware. Help is available
|
minimizing unwanted functionality (e.g. backdoors such as the Intel Management Engine)
|
||||||
via [\#libreboot IRC](https://web.libera.chat/#libreboot)
|
* ... which runs a payload such as SeaBIOS, GRUB, or U-Boot
|
||||||
on [Libera](https://libera.chat/) IRC.
|
* ... which loads your operating system's boot loader (BSD and Linux-based
|
||||||
|
[systems](systems) are supported).
|
||||||
|
|
||||||
Why use Libreboot?
|
Why use Libreboot, and what is coreboot?
|
||||||
==================
|
----------------------------------------
|
||||||
|
|
||||||
Why should you use *libreboot*?
|
A lot of users who use libre operating systems still use proprietary boot
|
||||||
----------------------------
|
firmware, which often contain backdoors and bugs, hampering
|
||||||
|
[user freedom](https://writefreesoftware.org) and
|
||||||
|
[right to repair](https://www.eff.org/issues/right-to-repair).
|
||||||
|
|
||||||
Libreboot gives you freedoms that you otherwise can't get with most other
|
[coreboot](https://coreboot.org) provides libre boot firmware by initializing
|
||||||
boot firmware. It's extremely powerful and configurable for many use cases.
|
the hardware then running a payload. However, coreboot is notoriously difficult
|
||||||
|
to configure and install for most non-technical users, requiring detailed
|
||||||
|
technical knowledge of hardware.
|
||||||
|
|
||||||
You have rights. The right to privacy, freedom of thought, freedom of speech
|
Libreboot solves this by being **a coreboot distribution** (in the same way
|
||||||
and the right to read. In this context, Libreboot gives you these rights.
|
that Alpine Linux is a Linux distribution). It provides a fully automated build
|
||||||
Your freedom matters.
|
system that downloads and compiles pre-configured ROM images for supported
|
||||||
[Right to repair](https://vid.puffyan.us/watch?v=Npd_xDuNi9k) matters.
|
motherboards, so end-users could easily fetch images to flash onto their
|
||||||
Many people use proprietary (non-libre)
|
devices.
|
||||||
boot firmware, even if they use [a libre OS](https://www.openbsd.org/).
|
|
||||||
Proprietary firmware often contains backdoors (more info on the FAQ), and it
|
|
||||||
and can be buggy. The libreboot project was founded in December 2013,
|
|
||||||
with the express purpose of making coreboot firmware accessible for
|
|
||||||
non-technical users.
|
|
||||||
|
|
||||||
The `libreboot` project uses [coreboot](https://www.coreboot.org/) for [hardware
|
Libreboot also produces documentation aimed at non-technical users and
|
||||||
initialisation](https://doc.coreboot.org/getting_started/architecture.html).
|
excellent user support via IRC.
|
||||||
Coreboot is notoriously difficult to install for most non-technical users; it
|
|
||||||
handles only basic initialization and jumps to a separate
|
|
||||||
[payload](https://doc.coreboot.org/payloads.html) program (e.g.
|
|
||||||
[GRUB](https://www.gnu.org/software/grub/),
|
|
||||||
[Tianocore](https://www.tianocore.org/)), which must also be configured.
|
|
||||||
*The libreboot software solves this problem*; it is a *coreboot distribution* with
|
|
||||||
an automated build system (named *lbmk*) that builds complete *ROM images*, for
|
|
||||||
more robust installation. Documentation is provided.
|
|
||||||
|
|
||||||
How does Libreboot differ from coreboot?
|
Contribute
|
||||||
========================================
|
----------
|
||||||
|
|
||||||
In the same way that *Debian* is a Linux distribution, `libreboot` is
|
|
||||||
a *coreboot distribution*. If you want to build a ROM image from scratch, you
|
|
||||||
otherwise have to perform expert-level configuration of coreboot, GRUB and
|
|
||||||
whatever other software you need, to prepare the ROM image. With *libreboot*,
|
|
||||||
you can literally download from Git or a source archive, and run `make`, and it
|
|
||||||
will build entire ROM images. An automated build system, named `lbmk`
|
|
||||||
(Libreboot MaKe), builds these ROM images automatically, without any user input
|
|
||||||
or intervention required. Configuration has already been performed in advance.
|
|
||||||
|
|
||||||
If you were to build regular coreboot, without using libreboot's automated
|
|
||||||
build system, it would require a lot more intervention and decent technical
|
|
||||||
knowledge to produce a working configuration.
|
|
||||||
|
|
||||||
Regular binary releases of `libreboot` provide these
|
|
||||||
ROM images pre-compiled, and you can simply install them, with no special
|
|
||||||
knowledge or skill except the ability to follow installation instructions
|
|
||||||
and run commands BSD/Linux.
|
|
||||||
|
|
||||||
Project goals
|
|
||||||
=============
|
|
||||||
|
|
||||||
- *Support as much hardware as possible!* Libreboot aims to eventually
|
|
||||||
have *maintainers* for every board supported by coreboot, at every
|
|
||||||
point in time.
|
|
||||||
- *Make coreboot easy to use*. Coreboot is notoriously difficult
|
|
||||||
to install, due to an overall lack of user-focused documentation
|
|
||||||
and support. Most people will simply give up before attempting to
|
|
||||||
install coreboot. Libreboot's automated build system and user-friendly
|
|
||||||
installation instructions solves this problem.
|
|
||||||
|
|
||||||
Libreboot attempts to bridge this divide by providing a build system
|
|
||||||
automating much of the coreboot image creation and customization.
|
|
||||||
Secondly, the project produces documentation aimed at non-technical users.
|
|
||||||
Thirdly, the project attempts to provide excellent user support via IRC.
|
|
||||||
|
|
||||||
Libreboot already comes with a payload (GRUB), flashprog and other
|
|
||||||
needed parts. Everything is fully integrated, in a way where most of
|
|
||||||
the complicated steps that are otherwise required, are instead done
|
|
||||||
for the user in advance.
|
|
||||||
|
|
||||||
You can download ROM images for your libreboot system and install
|
|
||||||
them without having to build anything from source. If, however, you are
|
|
||||||
interested in building your own image, the build system makes it relatively
|
|
||||||
easy to do so.
|
|
||||||
|
|
||||||
Not a coreboot fork!
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Libreboot is *not a fork of coreboot*. Every so often, the project
|
|
||||||
re-bases on the latest version of coreboot, with the number of custom
|
|
||||||
patches in use minimized. Tested, *stable* (static) releases are then provided
|
|
||||||
in Libreboot, based on specific coreboot revisions.
|
|
||||||
|
|
||||||
How to help
|
|
||||||
===========
|
|
||||||
|
|
||||||
You can check bugs listed on
|
You can check bugs listed on
|
||||||
the [bug tracker](https://codeberg.org/libreboot/lbmk/issues).
|
the [bug tracker](https://codeberg.org/libreboot/lbmk/issues).
|
||||||
|
|
||||||
If you spot a bug and have a fix, the website has instructions for how to send
|
You may use Codeberg pull requests to send patches with bug fixes or other
|
||||||
patches, and you can also report it. Also, this entire website is
|
improvements. This repository hosts the code for the main build system.
|
||||||
written in Markdown and hosted in a [separate
|
The website lives in [a separate repository](https://codeberg.org/libreboot/lbwww).
|
||||||
repository](https://codeberg.org/libreboot/lbwww) where you can send patches.
|
|
||||||
|
|
||||||
Any and all development discussion and user support are all done on the IRC
|
Development is also done on the IRC channel.
|
||||||
channel. More information is on <https://libreboot.org/contact.html>.
|
|
||||||
|
|
||||||
LICENSE FOR THIS README
|
License for this README
|
||||||
=======================
|
-----------------------
|
||||||
|
|
||||||
It's just a README file. This README file is released under the terms of the
|
It's just a README file. It is released under
|
||||||
Creative Commons Zero license, version 1.0 of the license, which you can
|
[Creative Commons Zero, version 1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt).
|
||||||
read here:
|
|
||||||
|
|
||||||
<https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt>
|
|
||||||
|
|||||||
Reference in New Issue
Block a user