Clean up README, move licensing to dep5 file
Change-Id: Ibb71bd6d86604a7bf300832f30e75935d95ffa9e
diff --git a/.gitreview b/.gitreview
deleted file mode 100644
index f742c18..0000000
--- a/.gitreview
+++ /dev/null
@@ -1,8 +0,0 @@
-# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
-# SPDX-License-Identifier: Apache-2.0
-
-[gerrit]
-host=gerrit.opencord.org
-port=29418
-project=ipxe-build.git
-defaultremote=origin
diff --git a/.reuse/dep5 b/.reuse/dep5
index 1bd17d1..cd236fa 100644
--- a/.reuse/dep5
+++ b/.reuse/dep5
@@ -1,5 +1,5 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Files: VERSION .gitreview chain.ipxe patches/*
+Files: README.md VERSION chain.ipxe patches/*
Copyright: 2020 Open Networking Foundation
License: Apache-2.0
diff --git a/README.md b/README.md
index a1ed9ba..a366d20 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,18 @@
-<!--
-SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
-SPDX-License-Identifier: Apache-2.0
---!>
# iPXE Build
-This repo will builds an [iPXE](https://ipxe.org/) payload that can be used for
-network booting of computer systems.
+This repo builds an [iPXE](https://ipxe.org/) payload that can be used for
+USB or network booting of systems.
Docker is used to build iPXE, wrapping [all build
dependencies](https://ipxe.org/download#source_code) in the Dockerfile, An
[embedded script](https://ipxe.org/embed) (`chain.ipxe`) is added which will
-chainload another iPXE script from a remote HTTP server and continue the boot
-process.
+chainload another iPXE script from a remote HTTP(S) server and continue the
+boot process.
-The chainloaded iPXE script is configured in the pxeboot role repo, which
-describes the menu, downloads boot images, etc.
+The chainloaded iPXE script which has the menu, OS files, and Debian preseed
+config is in the
+[pxeboot](https://gerrit.opencord.org/plugins/gitiles/ansible/role/pxeboot)
+ansible role.
## Requirements
@@ -27,14 +25,17 @@
Run `make image`, artifacts will be created in `out`. By default it will build:
- `undionly.kxpe` - Can be served by a DHCP server and chainloads with the
- NIC's built in PXE and network driver implementation
+ NIC's built in PXE UNDI network driver implementation
-- `ipxe.usb` - write to a USB stick with `dd if=bin/ipxe.usb of=/dev/<rawdevice>`
+- `ipxe.usb` - write to a USB stick with `dd if=bin/ipxe.usb
+ of=/dev/<rawdevice>`. There are also 32 and 64 bit EFI versions of this
+ payload.
- `ipxe.pdisk` - padded to floppy size, useful for some LOM implementations
- `ipxe.iso` - ISO image for writing to optical discs, and some other tools.
+
See also [build targets](https://ipxe.org/appnote/buildtargets).
## Mutual TLS
@@ -46,9 +47,10 @@
to the generated binaries. A patch is included that enables [HTTPS
Support](https://ipxe.org/buildcfg/download_proto_https).
-To use this support, the CA key, and public/private client keys must copied and
-built into the iPXE artifacts. As the private client keys are embedded, care
-must be taken with the resulting artifacts.
+To use this support, the CA key, and public/private client certificates must
+copied and built into the iPXE artifacts. As the private client certs are
+embedded, care must be taken with the resulting artifacts as they contain those
+client certs.
Steps: