SliTaz Repositories

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/cookutils/description.txt	Sat Nov 21 14:32:44 2020 +0100
     1.3 @@ -0,0 +1,47 @@
     1.4 +The SliTaz Cookutils provide tools and utils to build SliTaz packages.
     1.5 +
     1.6 +
     1.7 +Cook
     1.8 +----
     1.9 +
    1.10 +The cook tool should be used in a chroot environment: simply use the command
    1.11 +`tazdev gen-chroot` to build one. You can also build packages directly but
    1.12 +build deps will not be handled correctly since cook will install missing
    1.13 +packages to perform a build and then remove them only if they were not
    1.14 +installed before, this way we can keep a clean build environment.
    1.15 +
    1.16 +We use standard SliTaz paths to work such as /home/slitaz/wok, if you work on
    1.17 +cooking from stable or want to keep a clean system: create a chroot.
    1.18 +
    1.19 +
    1.20 +Cooker
    1.21 +------
    1.22 +
    1.23 +The Cooker is a Build Bot which automates the build process but doesn't make
    1.24 +the dinner for you! We need quality receipts to cook successfully and the goal
    1.25 +is not to have a bloated script so please Keep It Short and Simple.
    1.26 +
    1.27 +The web interface consists of one CGI script and one CSS style. Cook logs can
    1.28 +be produced by cook and the cooker just acts as a fronted to check them in
    1.29 +a nice way. A web interface also highlights success and error and can show
    1.30 +receipts and the cooker logs such as the last ordered list or commits check.
    1.31 +
    1.32 +
    1.33 +Cookiso
    1.34 +-------
    1.35 +
    1.36 +Cookiso is the official tool to automate the ISO build. The goal is to provide
    1.37 +a simple to use, rock solid tool with a web interface à la Cooker. It shares
    1.38 +configuration and templates with the Cooker but can be run on its own so it
    1.39 +can be used by contributors or customers to automate custom ISO building.
    1.40 +Cookiso must be run in a chroot which can be the same chroot as the Cooker.
    1.41 +
    1.42 +
    1.43 +Cross compiling
    1.44 +---------------
    1.45 +
    1.46 +Cookutils lets you cross compile a package for a specific architecture. Say you
    1.47 +want to build ARM binaries from a standard i486 machine. Cookutils provides
    1.48 +helpers for the ARM platform, but the first thing to do is compile a cross
    1.49 +toolchain and modify the main cook.conf variables to use the correct ARCH,
    1.50 +CFLAGS and BUILD_SYSTEM