[openap-cvs] : openap-main README,1.3,1.4

[David Kimdon <address@hidden>]

Update of /cvsroot/openap/openap-main
In directory subversions:/tmp/cvs-serv27884

Modified Files:
        README 
Log Message:
standardize subdirs, describe what variables are available


Index: README
===================================================================
RCS file: /cvsroot/openap/openap-main/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README      30 Jul 2002 00:06:44 -0000      1.3
+++ README      5 Aug 2002 21:42:24 -0000       1.4
@@ -25,14 +25,83 @@
 For more complicated operations please see Makefile and make/*.mk
 
 
-* CVS
+* Introduction
 
----------------------------------------------------------------------
-Anonymous access - Please follow the directions on savannah.gnu.org at
-http://savannah.gnu.org/cvs/?group_id=1202
+Facility is not an embedded Linux distribution.  Facility may be used to create
+an embedded Linux distribution.  In fact, that is the main intended use for
+Facility.
 
-Write access - Register yourself as a developer on savannah.gnu.org at
-https://savannah.gnu.org/account/register.php.  Then, email the project
-admins so that they can add your account to the project.
+The goal of Facility is to ease the job of embedded systems developers.
+Facility provides a unified framework for building and configuring a root
+filesystem and kernel.  It provides the base software needed by many embedded
+devices and provides a framework for easy integration of external software.
+Facility is flexible, easy to understand and modify and is released under the
+GNU GPL.  Facilty has been designed to be straight-forward, only depending on
+general knowledge of unix, shell scripting and makefiles.
+
+Facility is similar in some ways to the Linux kernel build system.  The heart 
of
+configuration management is a slightly modified version of the tool used to
+configure the Linux kernel.  The tool has been modified so that dependancies
+between the kernel and the filesystem can be tracked automatically.
+
+There are conceptually two different types of files that Facility creates.
+
+1. host tools: We need tools that create binaries for the target.  This 
includes
+the cross compiler, linker, libraries and header files.  These tools remain on
+the host (build) system in /opt/facility-<vers>/<target>-uclibc/.  Some of 
these
+files are compiled for the host (compiler, linker) while others are compiled 
for
+the target (assorted libraries).
+
+2. target files: These are the files that make up the image that is actually
+loaded onto the target hardware.  This includes the kernel and the root
+filesystem.  Typically these files are placed in a directory tree at install
+time and then some target specific operations are performed on the tree (for
+example creating an ext2 filesystem image and adding it to a kernel as an
+initrd) to create the final image.
+
+* Subdirectories 
+
+Each subdirectory contains a module, typically the source code from another
+software package, that has been modified to work with Facility.  Many well
+behaved packages will require little modification.  Some subdirs build host
+tools, some target files, and some build both host tools and target files.
+Building a subdir is controlled by the file 
+
+Each subdirectory must contain a file 'facility/rules'.  facility/rules is a
+makefile used to configure, build and install the package.  The subdirectory's
+behavior is controlled by variables including:
+
+CC, LD, AS, AR, STRIP, OBJCOPY
+    : compiler, linker etc. for the target
+
+INSTALL
+    : a BSD compatible install program
+
+CONFIG_SITE 
+    : target autoconf hints.  If the package uses GNU autoconf to configure 
this
+    file provides accurate values for various target specific options.
+
+DESTDIR 
+    : directory where target filesystem will be assembled.  Modules wishing to
+    install a binary that will be included in the target filesystem should
+    install to this directory.
+
+TOOLDIR 
+    : directory below which host tools will be installed
+
+BUILD_CC
+    : C compiler that will generate binaries that can be run on the host. 
+
+
+The above variables are available in the environment when the top-level 
makefile
+is invoked.  They are also available to a shell started by the 'xshell' target.
+
+facility/rules must exist support the following targets (though it is expected
+that some targets will be no-ops):
+
+build - build target files
+install - install target files into DESTDIR
+build_tools - build host tools
+install_tools - install host tools into TOOLDIR
+clean - remove all generated files
 
-----------------------------------------------------------------------