libreboot
/
lbwww
1
0
Fork 0
Code Packages Projects Releases Activity

Improved readibility for first time contributors 

The dedicated paragraph for the Sources makes more visible where the
repo is.
Improved the examples for the dependency resolution: now is clearer,
without digging into srcs that ubuntu2004 is just a special case, while
there's a generic target for debian based distros.
master
Andrea Perotti 2023-10-19 17:14:26 +02:00
parent 1500a15b5e
commit c8fe363ff3
1 changed files with 36 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
site/docs/build/index.md vendored
View File

@ -26,6 +26,13 @@ Introduction
libreboot's build system is named `lbmk`, short for `LibreBoot MaKe`, and this libreboot's build system is named `lbmk`, short for `LibreBoot MaKe`, and this
document describes how to use it. With this guide, you can know how to compile document describes how to use it. With this guide, you can know how to compile
libreboot from the available source code. libreboot from the available source code.
The following document describes how `lbmk` works, and how you can make changes
to it: [libreboot maintenance manual](../maintain/)
Sources
=======
This version, if hosted live on libreboot.org, assumes that you are using This version, if hosted live on libreboot.org, assumes that you are using
the `lbmk` git repository, which the `lbmk` git repository, which
you can download using the instructions on [the code review page](../../git.md). you can download using the instructions on [the code review page](../../git.md).
@ -35,9 +42,6 @@ documentation included with *that* release. libreboot releases are only intended
as *snapshots*, not for development. For proper development, you should always as *snapshots*, not for development. For proper development, you should always
be working directly in the libreboot git repository. be working directly in the libreboot git repository.
The following document describes how `lbmk` works, and how you can make changes
to it: [libreboot maintenance manual](../maintain/)
Git Git
=== ===
@ -61,8 +65,16 @@ You may also want to follow more of the steps here:
Python Python
====== ======
Python2 is unused by lbmk or anything that it pulls down as modules. You You should ensure that the `python` command runs python 3, on your system.
should ensure that the `python` command runs python 3, on your system. Python2 is unused by lbmk or anything that it pulls down as modules.
If building on Debian/Ubuntu based systems, you can achieve that via:
sudo apt install python-is-python3
On Fedora, you can use the following
sudo dnf install python-unversioned-command
Building Libreboot Building Libreboot
================== ==================
@ -71,18 +83,31 @@ Actual development/testing is always done using `lbmk` directly, and this
includes when building from source. Here are some instructions to get you includes when building from source. Here are some instructions to get you
started: started:
libreboot includes a script that automatically installs apt-get dependencies libreboot includes a script that automatically installs build dependencies
in Ubuntu 20.04 and distros based upon it: according to the selected linux distro.
The currently supported distros are: Debian/Ubuntu/Linux Mint/Pop!\_OS,
Fedora, Arch Linux/Parabola or Void Linux.
sudo ./build dependencies ubuntu2004 Some examples:
Separate scripts also exist: sudo ./build dependencies ubuntu
<or>
sudo ./build dependencies debian sudo ./build dependencies debian
sudo ./build dependencies arch <or>
sudo ./build dependencies void sudo ./build dependencies fedora38
<or>
sudo ./build dependencies arch
NOTE: In case of Ubuntu 20.04 LTS or derived distros, use the dedicated
configuration file:
sudo ./build dependencies ubuntu2004
Check: `config/dependencies/` for list of supported distros. Check: `config/dependencies/` for list of supported distros.