From 7fa225e680bab1b14e2e2f1743e4f96893746929 Mon Sep 17 00:00:00 2001 From: Nathan Fisher Date: Sat, 20 Feb 2021 10:03:28 -0500 Subject: [PATCH] Added README.md, formatted INSTALL as markdown. --- INSTALL => INSTALL.md | 24 ++++++++++++++---------- README.md | 22 ++++++++++++++++++++++ 2 files changed, 36 insertions(+), 10 deletions(-) rename INSTALL => INSTALL.md (75%) create mode 100644 README.md diff --git a/INSTALL b/INSTALL.md similarity index 75% rename from INSTALL rename to INSTALL.md index 0af7ca7..70d9034 100644 --- a/INSTALL +++ b/INSTALL.md @@ -1,4 +1,4 @@ -To bootstrap from another linux system: +## To bootstrap from another linux system: Make sure you have a full development environment installed including compiler, linker, headers etc. Git is also required for several stages, @@ -6,21 +6,25 @@ along with GNU wget. Commands following a # prompt are run as root, while those following a % prompt can be run as your normal user. Bind mount the source directory on /usr/src: - # mount -Bv /src - +``` +# mount -Bv /src +``` Create a link required for the correct installation of the temporary toolchain: - # ln -sv /build/toolchain /toolchain - +``` +# ln -sv /build/toolchain /toolchain +``` Set up the environment by sourcing an included script: - # source scripts/setenv.sh - +``` +# source scripts/setenv.sh +``` The system is now bootstrapped with minimal changes to the host. Should you wish to abort partway through and continue later, simply unmount /src and then remount it when ready to begin again. To build the system: - % make buildtools - % make buildworld - +``` +% make buildtools +% make buildworld +``` This creates a complete root filesystem in /src/build diff --git a/README.md b/README.md new file mode 100644 index 0000000..6aa5cd8 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Hitch Hiker Linux +## Source and build tree +### #!/don't/panic +This is the source and build tree for the Hitch Hiker Linux base system. It is +organized thus: +``` +. +├── build The output directory +├── distfiles Downloaded source tarballs +├── include Included Makefiles and headers +├── scripts Support scripts +├── toolchain Build tree for the toolchain and Glibc +└── world Build tree for the base system +``` +The subdirectories ```toolchain``` and ```world``` are further subdivided by +individual program and source package. Many of the subdirectories just wrap the +HitchHiker build system around that of third party sources. However, the special +subdirectories ```bin```, ```sbin```, ```usr.bin```, ```usr.sbin```, and ```lib``` +contain sources that are imported directly into HitchHiker, or written specifically +for it, and build directly using Make. + +For overall instructions for building the sources, see INSTALL.md