# HG changeset patch
# User Christophe Lincoln <pankso@slitaz.org>
# Date 1332626011 -3600
# Node ID bf30826e775b5ccc9c952780ad79aaa3444a1e40

Initial commit with the README file

diff -r 000000000000 -r bf30826e775b README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Mar 24 22:53:31 2012 +0100
@@ -0,0 +1,104 @@
+SliTaz Pizza
+================================================================================
+
+
+The SliTaz Pizza provide tools and utils to build Live systems online.
+
+
+	* Build ISO flavor online in a simple to use and modern interface
+	* Use stable packages or cooking if next to a stable release
+	* Build queue and one build at time to be less resources intensiv
+	* Can be run localy as a frontend to Tazlito or from the cmdline
+	* Produce standard and valid HTML code and wildly themable
+	* Provide a status page to follow build process for each flavor
+	* Create a tarball of the flavor receipt, list and addfiles
+	* Log activities, build process and provide useful statistics
+	* Keep ISO images and files public a while, then archive them
+	* Uniq ID strings for each flavor and mail notification
+	* RSS feed for all new builded flavors and summary on web interface
+
+
+Build process
+-------------
+First you have to choose the distro name, provide a short description,
+a valid email address so Pizza can notify you when ISO is built or in
+case the build failed. You must also choose a skeleton to base your
+custom distro on. Then add some packages and follow the steps. When
+validate the build, Pizza will create a tarball of your flavors a add
+it to the build queue, so it can take some time before your ISO image
+is generated.
+
+
+FAQ
+---
+
+	* Is it long to build ?
+    
+	  By default Pizza build a distro each 20 min but skip a run if an
+	  other distro is still building. After it depend on the build queue,
+	  and the size of your custom SliTaz distro.
+
+	* How long do you keep my ISO ?
+	
+	  We can't garanty hosting for long time actually, we will keep your
+	  product as long as wee can. But surely enough time to share it with
+	  your friends or family.
+
+
+
+Installation and Administration
+-------------------------------
+Pizza use a chroot to build ISO and a web interface to create the flavor
+file. Pizza can be installed and setup in a few commands. The package provide
+pizza host utility, pizza-bot build bot for chroot and pizza.cgi wich is
+the web interface main script. So let's go throught the installation:
+
+# tazpkg -gi slitaz-pizza
+
+Or from Hg:
+
+# hg clone http://hg.slitaz.org/slitaz-pizza
+# cd pizza && make install
+
+You can display a list of command an a short usage with the usage command.
+Create the chroot and build environment. You may want to have a look
+at Pizza configuration file before processing:
+
+# pizza setup
+
+Now you ready to start the build bot to build queued flavors one by one.
+You can also chroot in the environment to build manually or test.
+
+# pizza start
+
+In time they may be quiet a lot of ISO and temporary files. To clean up the
+temporary files and old flavors files:
+
+# pizza purge
+
+The cron task is run in the chroot and check if any flavor have been submited,
+by default it check all 20 minutes. The bot frenquency can be changed by
+editing root crontabs in the build chroot.
+
+To check build queue or chroot manually your can use:
+
+# pizza exec pizza-bot
+# pizza chroot
+
+
+Developers and translators
+--------------------------
+SHell script as you could expected. Keep speed in mind and security. Always
+think to have a simple option and a advanced option, for example in rootfs
+modification let users add custom wallpaper easely and advanced users can
+upload a full roootfs.
+
+Pizza has been coded from the beginning with gettext support. Please forget
+'echo' and use gettext, but remember that gettext "" is equivalent to echo -n.
+To start a new translation please use msginit from the pot file directory.
+Example for French/France locale (fr_FR):
+
+	$ msginit -l fr_FR -o fr.po -i pizza.pot
+
+
+================================================================================