Browse Source

Added README.md, formatted INSTALL as markdown.

odin
Nathan Fisher 9 months ago
parent
commit
7fa225e680
  1. 24
      INSTALL.md
  2. 22
      README.md

24
INSTALL → 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 <path to sourcedir> /src
```
# mount -Bv <path to sourcedir> /src
```
Create a link required for the correct installation of the temporary
toolchain:
# ln -sv <path to sourcedir>/build/toolchain /toolchain
```
# ln -sv <path to sourcedir>/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

22
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
Loading…
Cancel
Save