target/sdk: strip host binaries before packing
[openwrt.git] / README
diff --git a/README b/README
index d718e59..32e698d 100644 (file)
--- a/README
+++ b/README
@@ -1,29 +1,35 @@
-This is the buildsystem for the OpenWrt Linux Distribution
-It is a modified uClibc buildroot2.
+This is the buildsystem for the OpenWrt Linux distribution.
 
 Please use "make menuconfig" to configure your appreciated
 configuration for the toolchain and firmware.
 
-Simply running 'make' will build your firmware and a tarball
-of kernel modules. It will download all sources, build the 
-cross-compile toolchain, the kernel and all choosen applications.
+You need to have installed gcc, binutils, bzip2, flex, python, perl
+make, find, grep, diff, unzip, gawk, getopt, libz-dev and libc headers.
 
-You can use flash.sh for remotely updating your embedded system
-via tftp.
+Run "./scripts/feeds update -a" to get all the latest package definitions
+defined in feeds.conf / feeds.conf.default respectively
+and "./scripts/feeds install -a" to install symlinks of all of them into
+package/feeds/.
 
+Use "make menuconfig" to configure your image.
 
-There are some cleanup targets we would like to explain.
-"make clean" will only clean the firmware images and the root
-filesystem. "make dirclean" will remove the extracted kernel source
-and all exctracted software. (busybox,bridge-utils,..), but will
-preserve your toolchain. (compiler,linker,..)
-"make distclean" will remove everything, including the toolchain, 
-all downloaded source code archives and your firmware configuration. 
-You can cleanup separate directories by using "make application-dirclean" 
-and rebuild the firmware with "make".
+Simply running "make" will build your firmware.
+It will download all sources, build the cross-compile toolchain, 
+the kernel and all choosen applications.
 
-Be happy..
-       Your OpenWRT Project
-       http://www.openwrt.org
+You can use "scripts/flashing/flash.sh" for remotely updating your embedded
+system via tftp.
+
+The OpenWrt system is documented in docs/. You will need a LaTeX distribution
+and the tex4ht package to build the documentation. Type "make -C docs/" to build it.
+
+To build your own firmware you need to have access to a Linux, BSD or MacOSX system
+(case-sensitive filesystem required). Cygwin will not be supported because of
+the lack of case sensitiveness in the file system.
+
+
+Sunshine!
+       Your OpenWrt Project
+       http://openwrt.org