slitaz-pizza rev 0

Initial commit with the README file
author Christophe Lincoln <pankso@slitaz.org>
date Sat Mar 24 22:53:31 2012 +0100 (2012-03-24)
parents
children 154e0522d7aa
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sat Mar 24 22:53:31 2012 +0100
     1.3 @@ -0,0 +1,104 @@
     1.4 +SliTaz Pizza
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +The SliTaz Pizza provide tools and utils to build Live systems online.
     1.9 +
    1.10 +
    1.11 +	* Build ISO flavor online in a simple to use and modern interface
    1.12 +	* Use stable packages or cooking if next to a stable release
    1.13 +	* Build queue and one build at time to be less resources intensiv
    1.14 +	* Can be run localy as a frontend to Tazlito or from the cmdline
    1.15 +	* Produce standard and valid HTML code and wildly themable
    1.16 +	* Provide a status page to follow build process for each flavor
    1.17 +	* Create a tarball of the flavor receipt, list and addfiles
    1.18 +	* Log activities, build process and provide useful statistics
    1.19 +	* Keep ISO images and files public a while, then archive them
    1.20 +	* Uniq ID strings for each flavor and mail notification
    1.21 +	* RSS feed for all new builded flavors and summary on web interface
    1.22 +
    1.23 +
    1.24 +Build process
    1.25 +-------------
    1.26 +First you have to choose the distro name, provide a short description,
    1.27 +a valid email address so Pizza can notify you when ISO is built or in
    1.28 +case the build failed. You must also choose a skeleton to base your
    1.29 +custom distro on. Then add some packages and follow the steps. When
    1.30 +validate the build, Pizza will create a tarball of your flavors a add
    1.31 +it to the build queue, so it can take some time before your ISO image
    1.32 +is generated.
    1.33 +
    1.34 +
    1.35 +FAQ
    1.36 +---
    1.37 +
    1.38 +	* Is it long to build ?
    1.39 +    
    1.40 +	  By default Pizza build a distro each 20 min but skip a run if an
    1.41 +	  other distro is still building. After it depend on the build queue,
    1.42 +	  and the size of your custom SliTaz distro.
    1.43 +
    1.44 +	* How long do you keep my ISO ?
    1.45 +	
    1.46 +	  We can't garanty hosting for long time actually, we will keep your
    1.47 +	  product as long as wee can. But surely enough time to share it with
    1.48 +	  your friends or family.
    1.49 +
    1.50 +
    1.51 +
    1.52 +Installation and Administration
    1.53 +-------------------------------
    1.54 +Pizza use a chroot to build ISO and a web interface to create the flavor
    1.55 +file. Pizza can be installed and setup in a few commands. The package provide
    1.56 +pizza host utility, pizza-bot build bot for chroot and pizza.cgi wich is
    1.57 +the web interface main script. So let's go throught the installation:
    1.58 +
    1.59 +# tazpkg -gi slitaz-pizza
    1.60 +
    1.61 +Or from Hg:
    1.62 +
    1.63 +# hg clone http://hg.slitaz.org/slitaz-pizza
    1.64 +# cd pizza && make install
    1.65 +
    1.66 +You can display a list of command an a short usage with the usage command.
    1.67 +Create the chroot and build environment. You may want to have a look
    1.68 +at Pizza configuration file before processing:
    1.69 +
    1.70 +# pizza setup
    1.71 +
    1.72 +Now you ready to start the build bot to build queued flavors one by one.
    1.73 +You can also chroot in the environment to build manually or test.
    1.74 +
    1.75 +# pizza start
    1.76 +
    1.77 +In time they may be quiet a lot of ISO and temporary files. To clean up the
    1.78 +temporary files and old flavors files:
    1.79 +
    1.80 +# pizza purge
    1.81 +
    1.82 +The cron task is run in the chroot and check if any flavor have been submited,
    1.83 +by default it check all 20 minutes. The bot frenquency can be changed by
    1.84 +editing root crontabs in the build chroot.
    1.85 +
    1.86 +To check build queue or chroot manually your can use:
    1.87 +
    1.88 +# pizza exec pizza-bot
    1.89 +# pizza chroot
    1.90 +
    1.91 +
    1.92 +Developers and translators
    1.93 +--------------------------
    1.94 +SHell script as you could expected. Keep speed in mind and security. Always
    1.95 +think to have a simple option and a advanced option, for example in rootfs
    1.96 +modification let users add custom wallpaper easely and advanced users can
    1.97 +upload a full roootfs.
    1.98 +
    1.99 +Pizza has been coded from the beginning with gettext support. Please forget
   1.100 +'echo' and use gettext, but remember that gettext "" is equivalent to echo -n.
   1.101 +To start a new translation please use msginit from the pot file directory.
   1.102 +Example for French/France locale (fr_FR):
   1.103 +
   1.104 +	$ msginit -l fr_FR -o fr.po -i pizza.pot
   1.105 +
   1.106 +
   1.107 +================================================================================