aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2017-03-24 10:10:56 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2017-03-24 10:10:56 +0200
commit519557ffe8d6c88d1cb6fdb9120b06185042cd99 (patch)
tree0e820cceb4f24fe6cf9f55e7647d5d923c32d35d /README
parent603657a166bff4a16606a2575364446171466af6 (diff)
Setup docs infra
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 13 insertions, 28 deletions
diff --git a/README b/README
index eac7786..c6c213f 100644
--- a/README
+++ b/README
@@ -1,35 +1,20 @@
-buildos is a Debian-based in-memory, net-booted operating system specialized
-for building software with the build2 toolchain.
+This package contains the build2 operating system bootstrap scripts.
-Configuration
--------------
+build2 is an open source, cross-platform toolchain for building and packaging
+C++ code. Its aim is a modern build system and package manager for the C++
+language that provide a consistent, out of the box interface across multiple
+platforms and compilers. For more information see:
-- Network is configured via DHCP. All Ethernet intrface that have carrier are
- tried in (some) order and the first interface that is successfully configure
- via DHCP is used.
+https://build2.org/
-- Hostname is configure from the DHCP information. Failed that, a name is
- generated based on the MAC address. @@ Maybe also kernel cmdline.
+See the NEWS file for the user-visible changes from the previous release.
-PXE
----
+See the LICENSE file for the distribution conditions.
-- Copy the kernel image and initrd to TFTP
+See the INSTALL file for the prerequisites and installation instructions.
-# mkdir -p /var/lib/tftpboot/buildos
-# cp buildos-image buildos-initrd /var/lib/tftpboot/buildos/
+See the doc/ directory for documentation.
-- Assuming the host has MAC address de-ad-be-ef-b8-da, create host-specific
- configuration (or use 'default' for the last path component to apply to
- all the hosts):
-
-# cat <<EOF >/var/lib/tftpboot/pxelinux.cfg/01-de-ad-be-ef-b8-da
-default buildos
-prompt 1
-timeout 50
-
-label buildos
- menu label buildos
- kernel /buildos/buildos-image
- append initrd=/buildos/buildos-initrd
-EOF
+Send questions, bug reports, or any other feedback to the users@build2.org
+mailing list. You can post without subscribing. See https://lists.build2.org
+for searchable archives, posting guidelines, etc.