From 520f90e5af70169abb53416b2456fa5443a38690 Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Sat, 01 Jun 2013 13:30:55 -0400 Subject: README: New file. --- diff --git a/README b/README new file mode 100644 index 0000000..28ceb65 --- /dev/null +++ b/README @@ -0,0 +1,64 @@ +Initial Port Bootstrap Scripts +============================== + +These scripts automate the bootstrapping of an initial port of ProteanOS. + +Prerequisites +------------- + +To bootstrap ProteanOS, you'll need a modern UNIX-like system. + +These scripts only support natively bootstrapping an any-linux-eglibc +architecture such as core-linux-eglibc. Therefore, you'll need a system running +Linux (or a compatible variant such as Linux-libre) and glibc (or a compatible +variant such as EGLIBC) on a CPU that matches the target CPU of the ProteanOS +architecture to be bootstrapped. + +You'll need to have the following software installed on your system: + + * opkbuild (version 3.0.0-alpha4 or later), + * opkhelper (version 3.0.0-beta3 or later), + * Sudo, + * GNU Binutils, + * GCC, + * GNU Make, + * Headers for your C library and Linux libc, + * zlib (library and headers), + * GNU Gettext, + * GMP (library and headers), + * GNU MPFR (library and headers), and + * GNU MPC (library and headers, version 1.0 or later). + +After installing opkbuild, be sure to run its mksysconf makefile with ARCH and +PLAT macros to install ProteanOS system configuration files on your system. For +example, to bootstrap the core-linux-eglibc dev port, run: + + ./mksysconf ARCH=core-linux-eglibc PLAT=dev + +Binutils, GCC, Make, and the libc headers can be installed on Debian GNU/Linux +by installing the build-essential package. + +These scripts have been tested on Debian GNU/Linux 7.0 (wheezy) with the libmpc3 +and libmpc-dev packages from Debian's jessie suite. + +Running +------- + +Following is an overview of the initial port bootstrap scripts: + + Name Description + ---------------------------------------------------------------------------- + bootstrap-main.sh Runs the other scripts to performs a full + bootstrap. + bootstrap-prepare.sh Downloads, configures, and patches packages to + be built. + bootstrap-stage1-build.sh Builds packages in stage 1 of the bootstrap. + bootstrap-stage1-install.sh Installs built stage 1 packages into a + bootstrap system directory. + bootstrap-stage1-test.sh Tests the installed bootstrap system in a + changed file system root. + +To perform a full bootstrap, simply run bootstrap-main.sh. To perform just one +step of the process, run one of the other scripts. + +The scripts can (and should) be run from a separate directory. -- cgit v0.9.1