cookutils rev 30

README: Add explaination about toolchain
author Christophe Lincoln <pankso@slitaz.org>
date Fri May 06 16:30:47 2011 +0200 (2011-05-06)
parents 8fc5b2a08f0e
children 62fa13d02142
files README
line diff
     1.1 --- a/README	Fri May 06 16:14:39 2011 +0200
     1.2 +++ b/README	Fri May 06 16:30:47 2011 +0200
     1.3 @@ -5,8 +5,8 @@
     1.4  The SliTaz Cookutils provide tools and utils to build SliTaz packages.
     1.5  
     1.6  
     1.7 -cook
     1.8 -----
     1.9 +Cook
    1.10 +--------------------------------------------------------------------------------
    1.11  The cook tool should be used in a chroot environment, simply use the command
    1.12  'tazdev gen-chroot' to build one. You can also build package directly but
    1.13  build deps will not be handled correctly since cook will install missing
    1.14 @@ -53,8 +53,8 @@
    1.15      * files.list.lzma  A files provides by all packages
    1.16  
    1.17  
    1.18 -cooker
    1.19 -------
    1.20 +Cooker
    1.21 +--------------------------------------------------------------------------------
    1.22  The Cooker is a Build Bot who automate the build process but dont do the diner
    1.23  for you! We need quality receipt to cook succefully and the goal is not to have
    1.24  a bloated script so please Keep It Short and Simple.
    1.25 @@ -69,9 +69,20 @@
    1.26  and the cooker logs such as the last ordered list or commits check.
    1.27  
    1.28  
    1.29 +Toolchain
    1.30 +--------------------------------------------------------------------------------
    1.31 +The rebuild the full SliTaz toolchain at once cook and the Cooker will use the
    1.32 +slitaz-toolchain package. No built-in code to manage that since it is not a
    1.33 +common task. The toolchain package will built all needed package in the correct
    1.34 +order, wich is very important.
    1.35 +
    1.36 +
    1.37  Coding style
    1.38 -------------
    1.39 +--------------------------------------------------------------------------------
    1.40 +Here are the cookutils coding style notes, follow them if you want your code
    1.41 +include in the package.
    1.42  
    1.43 +    * In all cases: KISS
    1.44      * Use tab and not space to ident
    1.45      * Use name rater than $1 $2 $2
    1.46      * Variables from config file are $UPERCASE