aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMirko Vogt <mirko@openwrt.org>2012-01-21 01:15:24 +0000
committerMirko Vogt <mirko@openwrt.org>2012-01-21 01:15:24 +0000
commit4828e8ff2315da37b2c05ed8598587c2e5684f1f (patch)
treec3dd189e266160dceea3ddec1f6fe62419b18e06
parent408b12ff760df0f103e36ba4d3dbffcba99778e9 (diff)
downloadupstream-4828e8ff2315da37b2c05ed8598587c2e5684f1f.tar.gz
upstream-4828e8ff2315da37b2c05ed8598587c2e5684f1f.tar.bz2
upstream-4828e8ff2315da37b2c05ed8598587c2e5684f1f.zip
trying to make README file a bit more helpful
SVN-Revision: 29837
-rw-r--r--README20
1 files changed, 14 insertions, 6 deletions
diff --git a/README b/README
index 2975e5ce6b..6d2b27fb3e 100644
--- 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