mirrors/limine
1
0
Fork 0
mirror of https://github.com/limine-bootloader/limine synced 2025-02-18 10:04:23 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: readme updates to talk about Nix

Browse Source
This commit is contained in:
Philipp Schuster 2024-03-21 17:22:30 +01:00
parent 98ab791492
commit 3802d27e55
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -82,23 +82,20 @@ Host utility binaries are provided for Windows.
*The following steps are not necessary if cloning a binary release. If so, skip to* *The following steps are not necessary if cloning a binary release. If so, skip to*
*"Installing Limine binaries".* *"Installing Limine binaries".*
### Prerequisites
### Building with Nix ### Building with Nix
This repository provides [Nix](https://nixos.org/)-based tooling for a convenient This repository provides [Nix](https://nixos.org/)-based tooling for a convenient
development environment and building Limine using Nix. 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. To build Limine completely in Nix
using the latest sources, you can run:
- `$ nix build .#\limine` (build with clang and `--enable-all`) - `$ nix build .#\limine` (build with clang and `--enable-all`)
Limine is not yet in `nixpkgs`. 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.
### Regular build ### Regular build
#### Prerequisites
In order to build Limine, the following programs have to be installed: In order to build Limine, the following programs have to be installed:
common UNIX tools (also known as `coreutils`), common UNIX tools (also known as `coreutils`),
`GNU make`, `grep`, `sed`, `find`, `awk`, `gzip`, `nasm`, `mtools` `GNU make`, `grep`, `sed`, `find`, `awk`, `gzip`, `nasm`, `mtools`
@ -147,6 +144,19 @@ make install # (or gmake where applicable)
## How to use ## How to use
### Consume via Nix
Limine is not yet in `nixpkgs`.
You can consume this as Nix flake:
```nix
{
inputs.limine.url = "github:limine-bootloader/limine/<branch>";
inputs.limine.inputs.nixpkgs.follows = "nixpkgs";
}
```
### UEFI ### UEFI
The `BOOT*.EFI` files are valid EFI applications that can be simply copied to The `BOOT*.EFI` files are valid EFI applications that can be simply copied to
the `/EFI/BOOT` directory of a FAT formatted EFI system partition. These files can the `/EFI/BOOT` directory of a FAT formatted EFI system partition. These files can