From 4b8141f7c723be313f47a25047c7ee02b3f1a143 Mon Sep 17 00:00:00 2001
From: Jonathon Anderson <janderson@ciq.co>
Date: Wed, 14 Dec 2022 12:27:56 -0700
Subject: [PATCH] Additions to and install staticfiles README

Building off the work in #581, add additional detail to the staticfiles
README, and install an iPXE README alongside the iPXE files in their
final location.

Closes #189

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
---
 Makefile                   |  1 +
 staticfiles/README-ipxe.md | 19 +++++++++++++++++++
 staticfiles/README.md      |  7 +++++--
 3 files changed, 25 insertions(+), 2 deletions(-)
 create mode 100644 staticfiles/README-ipxe.md

diff --git a/Makefile b/Makefile
index 23e8ad2f..6c56fb20 100644
--- a/Makefile
+++ b/Makefile
@@ -198,6 +198,7 @@ files: all
 	cp bash_completion.d/warewulf $(DESTDIR)$(BASHCOMPDIR)
 	cp man_pages/*.1* $(DESTDIR)$(MANDIR)/man1/
 	cp man_pages/*.5* $(DESTDIR)$(MANDIR)/man5/
+	install -m 0644 staticfiles/README-ipxe.md $(DESTDIR)$(WWDATADIR)/ipxe
 	install -m 0644 staticfiles/arm64.efi $(DESTDIR)$(WWDATADIR)/ipxe
 	install -m 0644 staticfiles/x86_64.efi $(DESTDIR)$(WWDATADIR)/ipxe
 	install -m 0644 staticfiles/x86_64.kpxe $(DESTDIR)$(WWDATADIR)/ipxe
diff --git a/staticfiles/README-ipxe.md b/staticfiles/README-ipxe.md
new file mode 100644
index 00000000..19df4ed7
--- /dev/null
+++ b/staticfiles/README-ipxe.md
@@ -0,0 +1,19 @@
+# Warewulf-provided iPXE binaries
+
+- `arm64.efi` - EFI support for `arm64` processors
+- `x86_64.efi` - EFI support for `x86_64` processors
+- `x86_64.kpxe` - legacy BIOS support for `x86_64` processors
+
+## Rebuilding
+
+The iPXE binaries can be rebuilt with the `ipxe-update.sh`
+script. This script accepts command-line arguments that are passed to
+the underlying `make` process. e.g.,
+
+```bash
+echo "#!ipxe
+echo Tagging with vlan 1000
+vcreate --tag 1000 net0 autoboot || shell" >vlan-1000.ipxe
+
+sh ipxe-update.sh EMBED=$(readlink -f vlan-1000.ipxe)
+```
diff --git a/staticfiles/README.md b/staticfiles/README.md
index 8e0e8b34..01c2460d 100644
--- a/staticfiles/README.md
+++ b/staticfiles/README.md
@@ -1,2 +1,5 @@
-# iPXE binaries
-Binaries can be rebuild with the `ixpe-update.sh` script.
+# Warewulf-bundled static files
+
+These files are bundled statically with Warewulf 4.
+
+See also: [README-ipxe.md](README-ipxe.md)