cookutils rev 0

Initial commit with README
author Christophe Lincoln <pankso@slitaz.org>
date Tue May 03 22:30:08 2011 +0200 (2011-05-03)
parents
children 04526db035f3
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue May 03 22:30:08 2011 +0200
     1.3 @@ -0,0 +1,62 @@
     1.4 +SliTaz Cookutils
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +The SliTaz Cookutils provide tools and utils to build SliTaz packages.
     1.9 +
    1.10 +
    1.11 +cook
    1.12 +----
    1.13 +The cook tool should be used in a chroot environment, simply use the command
    1.14 +'tazdev gen-chroot' to build one. You can also build package directly but
    1.15 +build deps will not be handled correctly since cook will install missing
    1.16 +packages to perform a build and then remove them only if there wasn't
    1.17 +installed before, this way we can keep a clean build environment.
    1.18 +
    1.19 +We use standard SliTaz path to work such as /home/slitaz/wok, if you work on
    1.20 +cooking from stable or want to keep a clean system: create a chroot.
    1.21 +
    1.22 +Cook features:
    1.23 +
    1.24 +    * Setup a build env
    1.25 +    * Check and install missing build deps
    1.26 +    * Compile and generate the package
    1.27 +    * Remove installed build deps
    1.28 +    * Provide a log for each cook
    1.29 +    * Clean a package in the wok
    1.30 +
    1.31 +Cook does not:
    1.32 +
    1.33 +    * Depends on Hg but can use it to manage a wok
    1.34 +    * Do complex work about compiling the all system from source
    1.35 +    * Check build deps for you, use: BUILD_DEPENDS
    1.36 +      If all deps are also build deps do: BUILD_DEPENDS="$DEPENDS"
    1.37 +    * The work of a Build Bot, unix philosophy: one tool for one task
    1.38 +    * Cook a package if you receipt is crappy :-)
    1.39 +
    1.40 +Cook also manage packages list so they can be used for a personnal packages
    1.41 +repository or sent to the official mirror. We create and use:
    1.42 +
    1.43 +    * packages.list    Simple list of package-version
    1.44 +    * packages.md5     MD5sum list of all packages
    1.45 +    * packages.desc    Packages with name, version, category, desc
    1.46 +    * packages.equiv   Equivalent paclages list
    1.47 +    * files.list.lzma  A files provides by all packages
    1.48 +
    1.49 +
    1.50 +cooker
    1.51 +------
    1.52 +The Cooker is a Build Bot who automate the build process but dont do the diner
    1.53 +for you! We need quality receipt to cook succefully and the goal is not to have
    1.54 +a bloated script so please Keep It Short and Simple.
    1.55 +
    1.56 +Cmdline tool  : /usr/bin/cooker
    1.57 +Web interface : /var/www/cooker
    1.58 +Cache folder  : /home/slitaz/cache
    1.59 +
    1.60 +The web interface consist in one CGI script, 2 xHTML files and a CSS style.
    1.61 +Cook log can are produced by cook and the cooker just act as a fronted to
    1.62 +check them in a nice way.
    1.63 +
    1.64 +
    1.65 +================================================================================