Go to file
mintsuki 0e5facea95 docs: Update ChangeLog and README.md for 8.1.0 2024-10-12 04:00:56 +02:00
.github build(deps): bump crate-ci/typos from 1.25.0 to 1.26.0 2024-10-08 03:27:18 +00:00
common protos/limine: Work around GCC warning by initialising randomise_hhdm_base 2024-10-12 03:53:06 +02:00
decompressor build: freestanding-headers -> freestnd-c-hdrs-0bsd 2024-09-13 07:44:23 +02:00
host build: Remove files named 'Makefile' or 'GNUmakefile' as that confuses people 2024-08-17 12:42:25 +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 test: Fix build 2024-09-20 15:09:49 +02:00
.editorconfig build: Get rid of nix flake stuff 2024-08-01 05:59:31 +02:00
.gitignore build: Rebrand limine-efi to nyu-efi 2024-09-13 08:07:53 +02:00
.typos.toml misc: init typos for spell checking 2024-04-05 16:42:15 +02:00
CONFIG.md protos/limine: Add randomise_hhdm_base config option 2024-10-12 03:47:23 +02:00
COPYING misc: Update copyright years 2024-01-02 19:20:49 +01:00
ChangeLog docs: Update ChangeLog and README.md for 8.1.0 2024-10-12 04:00:56 +02:00
GNUmakefile.in build: Rebrand limine-efi to nyu-efi 2024-09-13 08:07:53 +02:00
PHILOSOPHY.md docs: PHILOSOPHY.md: Fix formatting issue 2024-10-12 03:21:30 +02:00
PROTOCOL.md mm/vmm: Complement 704dd7ee25 by not using WC caching on PTEs if not supported 2024-10-11 19:19:22 +02:00
README.md docs: Update ChangeLog and README.md for 8.1.0 2024-10-12 04:00:56 +02:00
USAGE.md docs: USAGE.md: Update mentions of limine.cfg to say limine.conf 2024-08-02 22:24:29 +02:00
bochsrc misc: Update bochsrc 2024-10-12 01:52:36 +02:00
bootstrap build: Fix wrong paths used for removal of .orig files for tinf 2024-10-12 02:46:20 +02:00
config.h.in build: Unbreak out of tree builds 2022-02-21 00:40:15 +01:00
configure.ac build: configure.ac: Run PROG_ABSPATH on PKG_CONFIG 2024-09-15 00:22:01 +02:00
limine.h protocol: Remove harmful *_MAX paging mode macros 2024-09-16 02:48:29 +02:00
logo.png docs: README.md: Further misc improvements 2024-05-03 20:00:14 +02:00
screenshot.png docs: Replace wallpaper and update screenshot 2024-08-29 16:07:45 +02:00
test.mk test: loongarch64 ovmf no longer needs alignment 2024-09-13 06:56:59 +02:00
version.sh build: Misc build system updates 2024-07-28 05:16:33 +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

Wallpaper by neotera (@ocso639)

Supported architectures

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

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, riscv64 and loongarch64 (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 8.x branch, one can do:

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

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

git clone https://github.com/limine-bootloader/limine.git --branch=v8.1.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".

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 GZIP decompression in early x86 BIOS stages.

Limine uses stb_image for wallpaper 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.