Extended MOTD with GUI
[tomato.git] / release / src / router / README
blob05b9c203f22b628528644a68b7e93dbb077037e2
2 # Broadcom Linux Router Configuration
4 # Copyright 2005, Broadcom Corporation
5 # All Rights Reserved.
6
7 # THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
8 # KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
9 # SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
10 # FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
12 # $Id: README,v 1.1.1.7 2005/03/07 07:31:12 kanki Exp $
15 * Introduction
17 To compile the Broadcom Linux Router package, you must have both
18 mipsel-linux and mipsel-uclibc toolchains in your PATH.
20 /opt/brcm/hndtools-mipsel-linux/bin
21 /opt/brcm/hndtools-mipsel-uclibc/bin
24 ** Configuration
26 To configure the package, type "make menuconfig". The Linux kernel will
27 be configured as well.
29 ** Compilation
31 To compile after configuring, type "make". The Linux kernel will be
32 built as well.
34 To compile only a particular module (e.g. rc), type "make rc".
36 ** Installation
38 To package for direct installation, type "make install" or "make
39 package". Linux kernel modules will be installed as well.
41 If uClibc was selected, "make install" will create a linux.trx file in
42 "mipsel-uclibc/". If uClibc was not selected, a linux.trx file will be
43 created in "mipsel/".
45 ** Cleaning
47 It is recommended that "make clean" be run after a configuration change
48 is made. By default, "make clean" will not clean the kernel. Uncomment
49 the last line of the "clean" target in the Makefile to enable kernel
50 cleaning.
52 * Customization
54 See config/Kconfig-language.txt for a description of the configuration
55 language used for user applications. Although its configuration program
56 appears similar, the Linux kernel uses a slightly different
57 language. See ../linux/linux/Documentation/kbuild/config-language.txt.
59 To add a new user application to the package, edit config/Config and
60 name the module rule under the "Configuration" section of the
61 Makefile. If the module can be built, cleaned, and installed with the
62 generic rules located at the end of the Makefile, no further changes are
63 necessary. Otherwise, add additional rules for the module under the
64 "Overrides" section of the Makefile. "make <module>" should descend into
65 the module directory and compile the sources. "make <module>-install"
66 should install the appropriate binaries as if "$(INSTALLDIR)/<module>"
67 were the root directory. "make <module>-clean" should clean generated
68 files from the module directory.
70 See the rules for "www" for a simple example.