trying to make README file a bit more helpful
authorMirko Vogt <mirko@openwrt.org>
Sat, 21 Jan 2012 01:15:24 +0000 (01:15 +0000)
committerMirko Vogt <mirko@openwrt.org>
Sat, 21 Jan 2012 01:15:24 +0000 (01:15 +0000)
SVN-Revision: 29837

README

diff --git a/README b/README
index 2975e5ce6be88f376bb65b31bae5ca8de762ff13..6d2b27fb3e8a5660344f4232c78dcd96e9a7cd3f 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-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.
@@ -6,18 +6,26 @@ configuration for the toolchain and firmware.
 You need to have installed gcc, binutils, patch, bzip2, flex,
 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.
 
-You can use scripts/flashing/flash.sh for remotely updating your embedded
+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.
+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.
 
-Building your own firmware you need to have access to a Linux, BSD or MacOSX system.
-Cygwin will not be supported because of the lack of case sensitiveness.
 
 Sunshine!
        Your OpenWrt Project