The Big Merge - Welcome SystemBoot

.gitignore

@@ -55,3 +55,4 @@ vmlinux
 
 # Vim swap files
 *.swp
+.*.swp

.stickler.yml

@@ -0,0 +1,5 @@
+linters:
+  golint:
+    fixer: true
+fixers:
+  enable: true

README.md

@@ -7,29 +7,75 @@
 
 # Description
 
-u-root contains simple Go versions of many standard Linux tools, similar to
-busybox. It's a pure Go userland!
+u-root embodies four different projects.
 
-u-root stands for "universal root". It can create an initramfs in two different
-modes:
+*   Go versions of many standard Linux tools, such as [ls](cmds/core/ls/ls.go),
+    [cp](cmds/core/cp/cp.go), or [shutdown](cmds/core/shutdown/shutdown.go). See
+    [cmds/core](cmds/core) for most of these.
 
-*   source mode: Go toolchain binaries + simple shell + Go source for tools to
-    be compiled on the fly by the shell.
+*   Go bootloaders that use `kexec` to boot Linux or multiboot kernels such as
+    ESXi, Xen, or tboot. They are meant to be used with
+    [LinuxBoot](https://www.linuxboot.org). With that, parsers for
+    [GRUB config files](pkg/diskboot) or [syslinux config files](pkg/syslinux)
+    are to make transition to LinuxBoot easier.
+
+*   A way to create very small Go programs using
+    [busybox mode](pkg/uroot/builder/bb/README.md) or source mode (see below).
+
+*   A way to create initramfs (an archive of files) to use with Linux kernels.
+
+# Creating Initramfs Archives
+
+u-root can create an initramfs in two different modes:
+
+*   source mode includes Go toolchain binaries + simple shell + Go source files
+    in the initramfs archive. Tools are compiled from source on the fly by the
+    shell.
 
     When you try to run a command that is not built, it is compiled first and
     stored in tmpfs. From that point on, when you run the command, you get the
     one in tmpfs. Don't worry: the Go compiler is pretty fast.
 
 *   bb mode: One busybox-like binary comprising all the Go tools you ask to
-    include.
+    include. See [here for how it works](pkg/uroot/builder/bb/README.md).
 
     In this mode, u-root copies and rewrites the source of the tools you asked
     to include to be able to compile everything into one busybox-like binary.
 
-# Contributing
+# SystemBoot
 
-For information about contributing, including how we sign off commits, please
-see CONTRIBUTING.md
+SystemBoot is a set of bootloaders written in Go. It is meant to be a
+distribution for LinuxBoot to create a system firmware + bootloader. All of
+these use `kexec` to boot. The commands are in [cmds/boot](cmds/boot).
+
+*   `pxeboot`: a network boot client that uses DHCP and HTTP or TFTP to get a
+    boot configuration which can be parsed as PXELinux or iPXE configuration
+    files to get a boot program.
+
+*   `fbnetboot`: a network boot client that uses DHCP and HTTP to get a boot
+    program based on Linux, and boots it. To be merged with `pxeboot`.
+
+*   `localboot`: a tool that finds bootable kernel configurations on the local
+    disks and boots them.
+
+*   `boot2`: similar to `localboot`, finds a bootable kernel configuration on
+    disk (GRUB or syslinux) and boots it. To be merged into `localboot`.
+
+*   `uinit`: a wrapper around `netboot` and `localboot` that just mimicks a
+    BIOS/UEFI BDS behaviour, by looping between network booting and local
+    booting. The name `uinit` is necessary to be picked up as boot program by
+    u-root.
+
+This project started as a loose collection of programs in u-root by various
+LinuxBoot contributors, as well as a personal experiment by
+[Andrea Barberio](https://github.com/insomniacslk) that has since been merged
+in. It is now an effort of a broader community and graduated to a real project
+for system firmwares.
+
+More detailed information about the build process for a full LinuxBoot firmware
+image using u-root/systemboot and coreboot can be found in the
+[LinuxBoot book](https://github.com/linuxboot/book) chapter 11,
+[LinuxBoot using coreboot, u-root and systemboot](https://github.com/linuxboot/book/blob/master/11.coreboot.u-root.systemboot/README.md).
 
 # Usage
 
@@ -45,9 +91,12 @@ You can now use the u-root command to build an initramfs. Here are some
 examples:
 
 ```shell
-# Build a bb-mode cpio initramfs of all the Go cmds in ./cmds/...
+# Build a bb-mode cpio initramfs of all the Go cmds in ./cmds/core/...
 u-root -build=bb
 
+# Generate a bb-mode archive with bootloaders
+u-root -build=bb core boot
+
 # Generate a cpio archive named initramfs.cpio.
 u-root -format=cpio -build=source -o initramfs.cpio
 
@@ -157,7 +206,8 @@ If you want to see u-root on real hardware, this
 
 # Contributions
 
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+For information about contributing, including how we sign off commits, please
+see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 Improving existing commands (e.g., additional currently unsupported flags) is
 very welcome. In this case it is not even required to build an initramfs, just