diff --git a/README.md b/README.md index 98401ce..0df3bb8 100644 --- a/README.md +++ b/README.md @@ -30,40 +30,44 @@ and produce final, ready to flash images. The following commands might be find to be usefull, while building the Kagera. Cleaning targets: - *) make clean - cleans just the packages for the current + +* make clean - cleans just the packages for the current configuration. This will keep .config in tact. - *) make distclean - cleans whole environment including the type of +* make distclean - cleans whole environment including the type of architecture. This will remove .config file as well as the build directory. - *) make mrproper - same as `make distclean`. +* make mrproper - same as `make distclean`. Configuration targets: - *) make config - this will provide a legacy, console-based + +* make config - this will provide a legacy, console-based interface to configure Kagera Build Environment. - *) make menuconfig - this will provide a 'graphical' interface to +* make menuconfig - this will provide a 'graphical' interface to select Kagera specific options such as target architecture or OpenWrt version. - *) make nconfig - this will provide an anternative 'graphical' +* make nconfig - this will provide an anternative 'graphical' interface to select Kagera specific options. - *) make oldconfig - updates current config utilising a .config file +* make oldconfig - updates current config utilising a .config file privided by user as a base - *) make kernel_menuconfig - this will launch a modern 'graphical' interface, +* make kernel_menuconfig - this will launch a modern 'graphical' interface, that allows to customize a set of options available in Linux Kernel used with Kagera. - *) make openwrt_menuconfig - if it is necessary to modify which packages +* make openwrt_menuconfig - if it is necessary to modify which packages the target image should contain, add a few utilities or libraries, this command will allow to alter default OpenWrt configuration. Generic targets: - *) make all - builds all selected target images - *) make world - `make all` equivalent + +* make all - builds all selected target images +* make world - `make all` equivalent Other targets: - *) make board - shows information about target architecture and + +* make board - shows information about target architecture and board(s), the final images are being built for - *) make help - displays this help - *) make version - shows the version of Kagera Firmware being built +* make help - displays this help +* make version - shows the version of Kagera Firmware being built To build your own firmware, you need to have access to a *BSD, Linux or Mac OSX