mtd-utils: get rid of extern inline to fix build errors
[openwrt/svn-archive/archive.git] / README
diff --git a/README b/README
index 2bba6fa6f6c8190e659145770d3d5cfeb01b45b9..6d2b27fb3e8a5660344f4232c78dcd96e9a7cd3f 100644 (file)
--- a/README
+++ b/README
@@ -1,21 +1,31 @@
-This is the buildsystem for the OpenWrt Linux distribution
+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.
 
-You need to have installed gcc, binutils, patch, bzip2, flex, bison,
+You need to have installed gcc, binutils, patch, bzip2, flex,
 make, gettext, pkg-config, unzip, libz-dev and libc headers.
 
 make, gettext, pkg-config, unzip, libz-dev and libc headers.
 
-Simply running 'make' will build your firmware.
+Run "./scripts/feeds update" to get the latest package definitions
+defined in feeds.conf / feeds.conf.default respectively
+and "./scripts/feeds install" to install symlinks 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.
 
 
-The buildroot system is documented in docs/buildroot-documentation.html.
+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.
 
 
-Building your own firmware you need to have access to a Linux system.
 
 Sunshine!
        Your OpenWrt Project
 
 Sunshine!
        Your OpenWrt Project