ubus: declare main version as ABI version for libubus
[openwrt.git] / README
diff --git a/README b/README
index 7db8637..32e698d 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +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.
 
 
 Please use "make menuconfig" to configure your appreciated
 configuration for the toolchain and firmware.
 
-Simply running 'make' will build your firmware.
+You need to have installed gcc, binutils, bzip2, flex, python, perl
+make, find, grep, diff, unzip, gawk, getopt, libz-dev and libc headers.
+
+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.
+
+Simply running "make" will build your firmware.
 It will download all sources, build the cross-compile toolchain, 
 the kernel and all choosen applications.
 
 It will download all sources, build the cross-compile toolchain, 
 the kernel and all choosen applications.
 
-You can use scripts/flash.sh for remotely updating your embedded system
-via tftp.
+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.
+
 
 
-Be happy..
+Sunshine!
        Your OpenWrt Project
        Your OpenWrt Project
-       http://www.openwrt.org
+       http://openwrt.org