Subversion Repositories crisos/svn

Welcome to CrisOs DarwinFox building system
*************************************************
                                http://crisos.org


1. Introduction - What is it CrisOs?
2. Bulding system
3. Patch system
4. Typical usage
5. Contibute

1. Introduction - What is it CrisOs?
-------------------
CrisOs isn't an OpenWrt fork! 
This project help us to keep a stable building enviroment over OpenWrt
changes, personalize the  firmware and integrate some dirty workaround.

2. Building system
-------------------
The OpenWrt system is well documented under openwrt/doc and will not 
addressed in this readme.
The darwinfox system have this directory layout:
darwinfox
    |--- helper         - this dir contain some script
    |--- openwrt        - contains the latest openwrt version
    \--- patches        - contains crisos patches
    

The darwinfox building system introduce some aliases and a simple patches 
manager.
The building system command are:
        svn update  - Update the crisos enviroment
        make patch - Apply crisos changes to openwrt
        make revert - Disapply ALL openwrt changes, this include crisos 
                patches and your own change!!
        make update - Update the openwrt version. 
                BEWARE: To prevent conflict during update make revert is 
                previously called.
        
Other useful target are:
        make install_feed - Install all openwrt ported programs from feeds
                (See also How to add crisos feed)

3. Patch system
-----------------
As discussed in 2  using 'make patch' all files under patches/ are 
applied to openwrt/

BEWARE: To prevent possible error due to previously applied patches ALL 
the changes 
        inside openwrt/ are reverted before applying patches!

For save your change BEFORE patch the openwrt with new set of patches save 
your change as follows:

1) enter the openwrt directory
2) make your change to one or more file 
3) save this change using:
        svn diff <file1> ... >  ../patches/<num>-<name>.patch 
where:
        <num> is a three digit number used for sort the patches
        <name> is a descriptive name

Use this method for save your change!

4. Typical use
-----------------
Typically you should follow this steps:

 * svn co svn://svn.tuxfamily.org/svnroot/crisos/svn/target/darwinfox
 * cd darwinfox
 * make patch <-- this apply the patches with crisos configuration
 * make mcm <-- ONLY IF YOU HAVE A MCM FOXBOARD
 * make menuconfig <-- choice Foxboard and wanted apps
 * make (good luck :p )
 * make flash <-- flash your fox trough eth0 interface

6. Contribute
-----------------
Any kind of support is welcome!

If you discover a bug or do you  like to contribute to  CrisOs please join 
mailing list, use IRC channel #crisos@freenode, report issue on bug system
http://crisos.org/flyspray/ and shares your patches.