source: README@ fcf5226

$Id$

1. INTRODUCTION::

     This collection of scripts, known as jhalfs-X, strives to create
  accurate makefiles from the Linux From Scratch book series XML files.
  This software was inspired by the "jhalfs" code written by Jeremy Huntwork.

     The usage of this script assumes you have read and are familiar with
  the book(s) and therefore the configuration variables found in config files
  will have meaning to you. There are a number of command line switches
  which, if used, will override the config file settings.

  NOTES::
  *.  The resulting Makefile takes considerable time to run to completion,
  lay in a supply of caffeine beverages.

  *.  It is recommended that you temporarily unpack your linux kernel and
  run <make menuconfig> and configure the kernal as per the book and save
  the resulting .config file. This configuration rule also applies to the
  configuration of the uClibc package when building a HLFS system using
  uClibc rather than glibc.

2. INSTALLATION::
     No installation is required. System-wide installation is not allowed
  for now.

3. CONFIGURATION FILES::
     Each book in the LFS series has it's own set of configurable parameters
  as well as the common parameters file.

4. RUNNING::
     The script, master.sh, cannot be invoked directly but only via the 
   supplied symlinks. After editing the config file for the project you wish
   to build run the script.
     <symlink> refers to the one of 4 package symlinks, lfs,hlfs,clfs,blfs. 
     Replace <symlink> with your choice.. i.e.  ./lfs

     ./<symlink>
     Creates a makefile based on the configurations settings found in the 
     config files. You must enter the build partition/jhalfs directory and
     manually run make

     ./<symlink> -G 
     Download the packages and patches necessary to build <symlink>
     
     ./<symlink> -G -M
     Download the packages, create and automatically run the Makefile
   
     ./<symlink> --help  will give you a context sensitive list of command
                         line switches.

5. LAYOUT::

        blfs --+  /BLFS config ---+             /common/config
               |       master.sh -+                    /common_functions
               |       xxxx.xsl  -+                    /makefile_functions
               |                                       /func_check_versions.sh
        clfs --+  /CLFS config ---+                    /func_validate_configs.sh
               |       master.sh -+
               |       xxxx.xsl  -+
               |
               +--------------------- master.sh --------------->>>
               +--README
               |
        hlfs --+  /HLFS config ---+
               |       master.sh -+
               |       xxxx.xsl  -+
               |
        lfs  --+  /LFS  config ---+
                       master.sh -+
                       xxxx.xsl  -+


6. FAQ::
    Q. "It doesn't work"
    A. Yes it does..


Authors:
  Manuel Canales Esparcia
  George Boudreau