SliTaz Repositories

     1.1 --- a/README	Fri May 06 23:41:09 2011 +0100
     1.2 +++ b/README	Sat May 07 05:41:58 2011 +0200
     1.3 @@ -35,14 +35,21 @@
     1.4      * The work of a Build Bot, unix philosophy: one tool for one task
     1.5      * Cook a package if your receipt is crappy :-)
     1.6  
     1.7 -Cook variables used in receipt:
     1.8 +Cook paths variables used in receipt:
     1.9  
    1.10 -    * $src     : Path to package source: wok/pkg/source
    1.11 -    * $stuff   : Path to package stuff: wok/pkg/stuff
    1.12 -    * $fs      : Path to package file system: wok/pkg/taz/*/fs
    1.13 -    * $install : Path to all installed files by the package
    1.14 +    * $src     : Package source: wok/pkg/source
    1.15 +    * $stuff   : Package stuff: wok/pkg/stuff
    1.16 +    * $fs      : Package file system: wok/pkg/taz/*/fs
    1.17 +    * $install : All installed files by the package
    1.18                   Old style is $_pkg and cook is compatible
    1.19  
    1.20 +Cook internal paths variables:
    1.21 +
    1.22 +    * $pkgdir  : Package directory in the wok: wok/pkg
    1.23 +    * $receipt : Package receipt in wok: wok/pkg/receipt
    1.24 +    * $taz     : The taz directory: wok/pkg/taz
    1.25 +    * $pack    : Package to compress: wok/taz/pkg-*
    1.26 +
    1.27  Cook also manages packages lists so they can be used for a personal packages
    1.28  repository or sent to the official mirror. We create and use:
    1.29  
    1.30 @@ -55,9 +62,9 @@
    1.31  
    1.32  Cooker
    1.33  --------------------------------------------------------------------------------
    1.34 -The Cooker is a Build Bot which automates the build process but doesn't make the dinner
    1.35 -for you! We need quality receipts to cook succesfully and the goal is not to have
    1.36 -a bloated script so please Keep It Short and Simple.
    1.37 +The Cooker is a Build Bot which automates the build process but doesn't make
    1.38 +the dinner for you! We need quality receipts to cook succesfully and the goal
    1.39 +is not to have a bloated script so please Keep It Short and Simple.
    1.40  
    1.41  Cmdline tool  : /usr/bin/cooker
    1.42  Web interface : /var/www/cgi-bin/cooker
    1.43 @@ -65,8 +72,8 @@
    1.44  
    1.45  The web interface consists of one CGI script and one CSS style. Cook logs can
    1.46  be produced by cook and the cooker just acts as a fronted to check them in
    1.47 -a nice way. A web interface also highlights success and error and can show receipts
    1.48 -and the cooker logs such as the last ordered list or commits check.
    1.49 +a nice way. A web interface also highlights success and error and can show
    1.50 +receipts and the cooker logs such as the last ordered list or commits check.
    1.51  
    1.52  
    1.53  Toolchain
    1.54 @@ -84,6 +91,7 @@
    1.55  
    1.56      * In all cases: KISS
    1.57      * Use tab and not space to indent
    1.58 +    * Max 80 char by line (try to edit in a Xterm 80x24)
    1.59      * Use names rather than $1 $2 $3
    1.60      * Variables from config file are $UPPERCASE
    1.61      * Variables initialized by cook are $lowercase