update for 0.10

git-svn-id: https://svn.pengutronix.de/svn/ptxdist/trunks/ptxdist-0.10-trunk@4618 33e552b5-05e3-0310-8538-816dae2090ed

1 files changed, 83 insertions, 43 deletions

diff --git a/README b/README
index b9feed621..f08726338 100644
--- a/README
+++ b/README
@@ -2,15 +2,51 @@ PTXdist
 =======
 
 
-Intro
------
+Installation
+------------
+
+To install PTXdist, just run 
+
+	./configure --prefix <installpath> 
+
+to configure the packet (FIXME: make this --prefix=/path..., probably by
+really autoconfigurizing), then
+
+	make
+
+to build everything and 
+
+	make install
+
+in case you want to install it. Make sure your $PATH environment
+variable points to <installpath>/bin, because that's where the ptxdist
+frontend program is being installed to. 
+
+For developers who want to work with svn versions of PTXdist it is only
+necessary to run "./configure && make" and set the PATH variable to the
+bin/ directory inside the PTXdist tree. 
+
+
+Quickstart
+----------
 
 For the impatient: try out to compile your own Linux system for generic
-i586 and above machines with 
+i586 and above machines by cloning the generic-i586-glibc project: 
+
+	somewhere$ ptxdist clone generic-i586-glibc myproject
+
+This copies the generic-i586-glibc project into ./myproject, which is
+your "workspace" for the following actions. 
+
+Change into your project's workspace and build everything: 
+
+	somewhere$ cd myproject
+	somewhere/myproject$ ptxdist go
+
+This builds a root filesystem into the root/ directory of your
+workspace. You can try it with 
 
-	make i586-generic-glibc_config
-	make world
-	chroot root/ /bin/sh
+	somewhere/myproject$ chroot root/ /bin/sh
 
 If you have more time to find out how it works, read on. 
 
@@ -23,46 +59,50 @@ kinds of Linux systems. It was written with embedded systems in mind,
 but there is no reason why you can't use it to configure your firewall,
 router or whatever dedicated "device" comes to your mind. 
 
-The job works like this: you run 'make menuconfig' or 'make xconfig',
-configure what you need and get a .config file. Run 'make world' and
-you'll find a root tree in root/. Voila. 
+The job works like this: you run 'ptxdist menuconfig', configure what
+you need and get a .config file. Run 'ptxdist go' and you'll find a 
+root tree in root/. Voila. 
 
 
-Directory layout
+Directory Layout
 ----------------
 
-build/		Here all the packages are extracted and being built
-config/		Configuration system, ext. configuration scripts
-		The actual config files live in rules/xxx.in
-images/		'make images' creates tarballs and filesystem images
-		in this directory. 
-local/		tools which are installed locally go to this dir
-projects/	Each project has a project directory here. Note that
-		there needs to be a corresponding .ptxconfig file in
-		this directory. 
-root/		root filesystem for the target
-rules/		Makefiles and Kconfig files for all packages
-scripts/	several little helper scripts
-src/		original sources and patches; normally you want to 
-		delete this directory and make it a symlink to your
-		real source directory. 
-state/		state files (show in which state packages currently are
-		during the compilation)
-
-
-Installation Instructions
--------------------------
-
-The installation takes it's configuration from a config file in the
-toplevel directory: .config. You can either copy them to this location
-or enter "make menuconfig" or "make xconfig" to generate a
-configuration. For predefined board support packages you can use "make
-foobar_config" to bring the config file in place.
-
-When everything is configured just enter "make world" and wait... The
-resulting root filesystem will be in the root/ directory. Just chroot
-into it for local tests (if your build host has the same architecture as
-your target) or copy it to your embedded system. 
+These files and directories are supposed to be in an empty project
+directory: 
+
+kernel-patches-native/	contains patch series for the kernel which is
+			compiled natively (for simulation)
+kernel-patches-target/	contains patch series for the target kernel
+kernelconfig.native	kernel .config file for the native kernel
+kernelconfig.target	kernel .config file for the target kernel
+patches/		project specific patches, overwrites the generic
+			ones from PTXdist
+projectroot/		put files here which are to be copied over to
+			the target's root directory, like for example 
+			etc files, scripts, ... Note that the copying
+			has to be done explicitly by some project
+			specific rule file.  
+ptxconfig		.config file to configure the userland for
+			your project. 
+rules/			contains project specific rules
+src -> ...		link to point to your directory containing
+			tarball files for the packets. 
+
+Additionally some other directories are being built when you run
+"ptxdist go" or other start other build targets. 
+
+build-host/		build directory for host tools
+build-cross/		build directory for cross tools
+build-target/		build directory for target tools
+images/			'ptxdist images' creates tarballs and 
+			filesystem images in this directory. 
+local/			tools which are installed locally go to this dir
+root/			root filesystem for the target
+state/			state files (show in which state packages 
+			currently are during the compilation)
+
+For more details look at the output of 'ptxdist --help' or see the
+PTXdist manual. 
 
 
 Bugs
@@ -71,5 +111,5 @@ Bugs
 - search for FIXMEs
 - see TODO, which is out of date :-) 
   
-Robert Schwebel <r.schwebel@pengutronix.de>, 2005-01-17
+Robert Schwebel <r.schwebel@pengutronix.de>, 2006-02-19