From d62059cfb48584dc731d75902cbc927855ed3b4d Mon Sep 17 00:00:00 2001 From: Felicitas Pojtinger Date: Tue, 29 Oct 2024 18:52:38 -0700 Subject: [PATCH] docs: Rewrite README to fit new conventions Signed-off-by: Felicitas Pojtinger --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0914b4d..e58ee1e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # iPXE Binaries -Weekly builds of [https://ipxe.org/](ipxe.org), with an [embedded script that chainloads /config.ipxe](./downstream/init.ipxe). +Weekly builds of [https://ipxe.org/](ipxe.org), with an [embedded script that chainloads /config.ipxe](./config/init.ipxe). + +[![hydrun CI](https://github.com/pojntfx/ipxe-binaries/actions/workflows/hydrun.yaml/badge.svg)](https://github.com/pojntfx/ipxe-binaries/actions/workflows/hydrun.yaml) ## Overview **Tired of re-compiling iPXE just to change the embedded script?** This repository, which provides builds of iPXE with an embedded script that chainloads `/config.ipxe` relative to the TFTP server that iPXE was booted from, might be of help to you! -A release `.tar.gz` archive with the latest iPXE release is built weekly and uploaded to [GitHub releases](https://github.com/pojntfx/ipxe-binaries/releases). - -Binaries are compiled with HTTPS support enabled and are being built for the following [iPXE build targets](https://ipxe.org/appnote/buildtargets): +Binaries are build with HTTPS support enabled for the following [iPXE build targets](https://ipxe.org/appnote/buildtargets): - `bin-i386-pcbios/ipxe.kpxe` - `bin-i386-efi/ipxe.efi` @@ -16,10 +16,30 @@ Binaries are compiled with HTTPS support enabled and are being built for the fol - `bin-arm32-efi/snp.efi` - `bin-arm64-efi/snp.efi` -Also included is a [bofied](https://github.com/pojntfx/bofied) configuration file ([config.go](./downstream/config.go)) and an example iPXE script ([config.ipxe](./downstream/config.ipxe)) which chainloads [netboot.xyz](https://netboot.xyz/). +Also included is a [bofied](https://github.com/pojntfx/bofied) configuration file ([config.go](./config/config.go)) and an example iPXE script ([config.ipxe](./config/config.ipxe)) which chainloads [netboot.xyz](https://netboot.xyz/). + +## Installation + +A release `.tar.gz` archive with the latest iPXE release is built weekly and uploaded to [GitHub releases](https://github.com/pojntfx/ipxe-binaries/releases). [bofied](https://github.com/pojntfx/bofied) automatically fetches this archive on its first startup by default. + +## Acknowledgements + +- [ipxe/ipxe](https://github.com/ipxe/ipxe) provides the sources that the binaries are built from. + +## Contributing + +To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md). + +To build the `.tar.gz` archive with the latest iPXE release locally, run the following: + +```shell +$ git clone https://github.com/pojntfx/ipxe-binaries.git +$ cd ipxe-binaries +$ hydrun -o debian:bookworm -i ./Hydrunfile c +``` ## License -ipxe-binaries (c) 2021 Felicitas Pojtinger and contributors +iPXE Binaries (c) 2024 Felicitas Pojtinger and contributors SPDX-License-Identifier: GPL-2.0