Go to file
mintsuki caf80b196a build: Restore WERROR_FLAG to nasm calls, add NASMFLAGS_FOR_TARGET 2024-07-27 09:25:13 +02:00
.github build(deps): bump crate-ci/typos from 1.21.0 to 1.22.9 2024-07-06 20:57:15 +02:00
common build: Restore WERROR_FLAG to nasm calls, add NASMFLAGS_FOR_TARGET 2024-07-27 09:25:13 +02:00
decompressor build: Restore WERROR_FLAG to nasm calls, add NASMFLAGS_FOR_TARGET 2024-07-27 09:25:13 +02:00
host host/limine: Protect against overwriting beginning of partitions located too low 2024-07-11 02:31:41 +02:00
man/man1 docs/man: Remove extra newlines from limine(1) manpage 2024-03-10 06:39:21 +01:00
stage1 stage1/gdt: Mark accessed flag in descriptors 2023-09-09 10:08:44 -05:00
test protos/limine: Specify and implement paging mode request revision 1 2024-07-18 23:13:41 +02:00
.editorconfig misc: init typos for spell checking 2024-04-05 16:42:15 +02:00
.envrc nix: init flake.nix 2024-03-19 15:09:38 +01:00
.gitignore build: .gitignore: Remove unused /common/font.bin line 2024-07-09 22:00:01 +02:00
.typos.toml misc: init typos for spell checking 2024-04-05 16:42:15 +02:00
CONFIG.md protos/limine: Specify and implement paging mode request revision 1 2024-07-18 23:13:41 +02:00
COPYING misc: Update copyright years 2024-01-02 19:20:49 +01:00
ChangeLog docs: Update ChangeLog and README.md for 7.12.0 2024-07-21 14:35:12 +02:00
GNUmakefile.in build: Restore WERROR_FLAG to nasm calls, add NASMFLAGS_FOR_TARGET 2024-07-27 09:25:13 +02:00
PHILOSOPHY.md docs: PHILOSOPHY.md: Fix typo 2024-07-21 14:35:12 +02:00
PROTOCOL.md docs: PROTOCOL.md: specify TCR_EL1.TnSZ values given paging levels 2024-07-21 14:35:12 +02:00
README.md docs: Update ChangeLog and README.md for 7.12.0 2024-07-21 14:35:12 +02:00
USAGE.md docs: Move usage to USAGE.md and install that instead of README.md 2024-05-03 20:26:21 +02:00
bochsrc vbe: Fix bug where the vbe tty double buffer did not properly refresh 2020-12-27 19:32:18 +01:00
bootstrap build: Minor improvements to bootstrap script 2024-07-27 09:25:13 +02:00
config.h.in build: Unbreak out of tree builds 2022-02-21 00:40:15 +01:00
configure.ac build: Restore WERROR_FLAG to nasm calls, add NASMFLAGS_FOR_TARGET 2024-07-27 09:25:13 +02:00
flake.lock nix: Remove build.nix 2024-04-10 15:31:00 +02:00
flake.nix nix: Remove build.nix 2024-04-10 15:31:00 +02:00
limine.h protos/limine: Specify and implement paging mode request revision 1 2024-07-18 23:13:41 +02:00
logo.png docs: README.md: Further misc improvements 2024-05-03 20:00:14 +02:00
screenshot.png docs: Update screenshot 2024-05-02 04:35:27 +02:00
test.mk Revert "fs: Drop ext2/3/4 support" 2024-07-21 14:35:12 +02:00
version.sh Revert "build: Make version gathering similar to timestamps gathering" 2024-04-14 23:41:45 +02:00

README.md

Limine

Limine's logo

What is Limine?

Limine (pronounced as demonstrated here) is a modern, advanced, portable, multiprotocol bootloader and boot manager, also used as the reference implementation for the Limine boot protocol.

Donate

If you want to support the work I (@mintsuki) do on Limine, feel free to donate to me on Liberapay: Donate using Liberapay

Donations welcome, but absolutely not mandatory!

Limine's boot menu

Reference screenshot

Photo by Mo Eid

Supported architectures

  • IA-32 (32-bit x86)
  • x86-64
  • aarch64 (arm64)
  • riscv64

Supported boot protocols

  • Linux
  • Limine
  • Multiboot 1
  • Multiboot 2
  • Chainloading

Supported partitioning schemes

  • MBR
  • GPT
  • Unpartitioned media

Supported filesystems

  • FAT12/16/32
  • ISO9660 (CDs/DVDs)
  • ext2/3/4 (NOTE: This is experimental and not supported. Maintainers wanted!)

If your filesystem isn't listed here, please read the philosophy first, especially before opening issues or pull requests related to this.

Minimum system requirements

For 32-bit x86 systems, support is only ensured starting with those with Pentium Pro (i686) class CPUs.

All x86-64, aarch64, and riscv64 (UEFI) systems are supported.

Packaging status

All Limine releases since 7.x use Semantic Versioning for their naming.

Packaging status

Binary releases

For convenience, for point releases, binaries are distributed. These binaries are shipped in the -binary branches and tags of this repository (see branches and tags).

For example, to clone the latest binary release of the 7.x branch, one can do:

git clone https://github.com/limine-bootloader/limine.git --branch=v7.x-binary --depth=1

or, to clone a specific binary point release (for example 7.12.0):

git clone https://github.com/limine-bootloader/limine.git --branch=v7.12.0-binary --depth=1

In order to rebuild host utilities like limine, simply run make in the binary release directory.

Host utility binaries are provided for Windows.

Building the bootloader

The following steps are not necessary if cloning a binary release. If so, skip to "Installing Limine binaries".

Building with Nix

This repository provides Nix-based tooling for a convenient development environment and building Limine using Nix.

To use the regular build flow using a toolchain obtained by Nix, simply run $ nix develop to open a Nix shell. Then follow the guide below, skipping the "Prerequisites" step.

Regular build

Prerequisites

In order to build Limine, the following programs have to be installed: common UNIX tools (also known as coreutils), GNU make, grep, sed, find, awk, gzip, nasm, mtools (optional, necessary to build limine-uefi-cd.bin). Furthermore, gcc or llvm/clang must also be installed, alongside the respective binutils.

Configure

If using a release tarball (recommended, see https://github.com/limine-bootloader/limine/releases), run ./configure directly.

If checking out from the repository, run ./bootstrap first in order to download the necessary dependencies and generate the configure script (GNU autoconf required).

./configure takes arguments and environment variables; for more information on these, run ./configure --help.

./configure by default does not build any Limine port. Make sure to read the output of ./configure --help and enable any or all ports!

Limine supports both in-tree and out-of-tree builds. Simply run the configure script from the directory you wish to execute the build in. The following make commands are supposed to be run inside the build directory.

Building Limine

To build Limine, run:

make    # (or gmake where applicable)

Installing Limine

This step will install Limine files to share, include, and bin directories in the specified prefix (default is /usr/local, see ./configure --help, or the PREFIX variable if installing from a binary release).

To install Limine, run:

make install    # (or gmake where applicable)

Usage

See USAGE.md.

Acknowledgments

Limine uses a stripped-down version of tinf for early GZIP decompression.

Limine relies on stb_image for runtime GZIP decompression and image loading.

Limine uses a patched version of libfdt (can be found in Linux's source tree) for manipulating FDTs.

Discord server

We have a Discord server if you need support, info, or you just want to hang out with us.