website rev 17

Devel part and install guide improved by Paul Issot
author Christophe Lincoln <pankso@slitaz.org>
date Tue Apr 08 00:31:14 2008 +0200 (2008-04-08)
parents 2ceb4453710d
children 7194d2ac8f55
files devel/guidelines.html en/devel/index.html en/doc/handbook/install.html
line diff
     1.1 --- a/devel/guidelines.html	Mon Apr 07 14:10:16 2008 +0200
     1.2 +++ b/devel/guidelines.html	Tue Apr 08 00:31:14 2008 +0200
     1.3 @@ -74,7 +74,7 @@
     1.4  Rester simple, respecter au mieux les standards, réaliser un travail soigné,
     1.5  rédiger de la documentation de haute qualité, fournir un système stable et
     1.6  robuste et garder le <em>rootfs</em> du LiveCD standard assé léger pour que
     1.7 -SliTaz tourne sur des machines ayant au minimum 90 Mb de RAM. Possibilité 
     1.8 +SliTaz tourne sur des machines ayant au minimum 128 Mb de RAM. Possibilité 
     1.9  d'utiliser GTK+2, Dialog, Gtkdialog, des scripts SHell ou encore PHP pour
    1.10  coder des outils propre à la distribution. L'idée est aussi de ne pas faire
    1.11  de doublons et de penser mini...
     2.1 --- a/en/devel/index.html	Mon Apr 07 14:10:16 2008 +0200
     2.2 +++ b/en/devel/index.html	Tue Apr 08 00:31:14 2008 +0200
     2.3 @@ -61,14 +61,26 @@
     2.4  <h1><font color="#3e1220">Developement</font></h1>
     2.5  <h2><font color="#df8f06">SliTaz Developers corner</font></h2>
     2.6  
     2.7 +<ul>
     2.8 +	<li><a href="#repos">Mercurial repositories.</a></li>
     2.9 +	<li><a href="#pkgs">Tazpkg packages.</a></li>
    2.10 +	<li><a href="#website">Website Management.</a></li>
    2.11 +</ul>
    2.12 +
    2.13  <p>
    2.14  SliTaz is an open source and community driven distribution. Everyone is welcome 
    2.15  to join and contribute, from  users, to hackers and developers there is always
    2.16  something to do, ie. Proofreading or writing documentation, sending bugs or 
    2.17  patches to the Mailing list, gaining access to the wok and pushing some new 
    2.18 -packages or simply to help others on the Mailing list or forum. SliTaz has got Mercurial
    2.19 -repositories hosted on a SliTaz system, developers can ask for a new repo if 
    2.20 -needed and contributors have write access to correct typos, scripts, etc.
    2.21 +packages or simply to help others on the Mailing list or forum. SliTaz has got
    2.22 +Mercurial repositories hosted on a SliTaz system, developers can ask for a new
    2.23 +repo if needed and contributors have write access to correct typos, scripts, etc.
    2.24 +</p>
    2.25 +
    2.26 +<p>
    2.27 +SliTaz is a tiny community and listens to it's users. There are several 
    2.28 +developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
    2.29 +and the <a href="../mailing-list.html">Mailing List</a>.
    2.30  </p>
    2.31  
    2.32  <a name="repos"></a>
    2.33 @@ -125,6 +137,72 @@
    2.34  Done, your changes, code or corrections are now on the server.
    2.35  </p>
    2.36  
    2.37 +<a name="pkgs"></a>
    2.38 +<h3>Tazpkg Packages</h3>
    2.39 +<p>
    2.40 +The packages tazpkg in SliTaz are automatically created via Tazwok and a 
    2.41 +receipt in the wok, the Cookbook describes the 
    2.42 +<a href="http://www.slitaz.org/doc/cookbook/wok-tools.html">use of tools (fr)</a> 
    2.43 +and the format <a href="http://www.slitaz.org/doc/cookbook/receipts.html">receipts (fr)</a>,
    2.44 +These are required reading before we begin.
    2.45 +</p>
    2.46 +<p>
    2.47 +In terms of choice of package, the idea is to offer a package by task or 
    2.48 +functionality, ie. the lightest application in the field and not duplicated. 
    2.49 +Note that the current packages are not immutable, if you find an alternative 
    2.50 +that is lighter, with more features or more <em>sexy</em> for a few extra KB, 
    2.51 +you can suggest it on the Mailing List. Particular attention is given to 
    2.52 +packages for the LiveCD; these should be stripped, removing unnecesary 
    2.53 +dependancies and compiler options. In general candidate packages for the core 
    2.54 +LiveCD are discussed on the Mailing List.
    2.55 +</p>
    2.56 +<p>
    2.57 +Before you begin to compile and create packages for SliTaz, be sure that the 
    2.58 +work doesn't already exist in the wok indigest provided by the primary SliTaz
    2.59 +mirror. Don't forget that the members of the list are there to help you
    2.60 +and that the documentation of the 
    2.61 +<a href="http://www.slitaz.org/doc/cookbook/wok-tools.html">wok and tools (fr)</a> 
    2.62 +exists to help you get started.
    2.63 +</p>
    2.64 +
    2.65 +<a name="site"></a>
    2.66 +<h3>Website Management and Books</h3>
    2.67 +<p>
    2.68 +The management of the website and books (Handbook &amp; Cookbook) is made via 
    2.69 +a rsync module, Mercurial, diff and patch utilities and the Mailing List. 
    2.70 +Rsync is a tool for incremental backup; using an ultra-fast algorithm, It can 
    2.71 +transfer or syncronize data both locally or over the network. The 
    2.72 +<code>diff</code> utility is used to send the list of files containing only 
    2.73 +the changes and <code>patch</code> to apply the changes to the original pages.
    2.74 +</p>
    2.75 +<p>
    2.76 +You can syncronize the site and books graphically using Grsync or via the 
    2.77 +command line. To download the site for the first time or syncronize the pages 
    2.78 +in the directory <code>/home/hacker/Public/slitaz/website</code>, 
    2.79 +use the module <code>rsync://slitaz.org/website</code>:
    2.80 +</p>
    2.81 +<pre>
    2.82 + $ rsync -r -t -p -v \
    2.83 +       --progress --delete \
    2.84 +       rsync://slitaz.org/website /home/hacker/Public/slitaz/website
    2.85 +</pre>
    2.86 +<h4>Diff and patch</h4>
    2.87 +<p>
    2.88 +The utilities <code>diff</code> and <code>patch</code> are command-line tools 
    2.89 +for creating and implementing the differences between two files. This technique
    2.90 +is often used for collaboration and the changes made to the original file can 
    2.91 +be clearly extracted. To create a <code>diff</code> file readable by humans in
    2.92 +a simple text editor, you must supply the <code>-u</code> option:
    2.93 +</p>
    2.94 +<pre>
    2.95 + $ diff -u file.orig file.new &gt; file.diff
    2.96 +</pre>
    2.97 +<p>
    2.98 +To apply a patch:
    2.99 +</p>
   2.100 +<pre>
   2.101 + $ patch file.orig file.diff
   2.102 +</pre>
   2.103  
   2.104  <!-- End of content with round corner -->
   2.105  </div>
     3.1 --- a/en/doc/handbook/install.html	Mon Apr 07 14:10:16 2008 +0200
     3.2 +++ b/en/doc/handbook/install.html	Tue Apr 08 00:31:14 2008 +0200
     3.3 @@ -40,34 +40,34 @@
     3.4  <a name="intro"></a>
     3.5  <h3>Introduction</h3>
     3.6  <p>
     3.7 -This document give some informations and necessary instructions on how to 
     3.8 -install SliTaz on a hard disk. You will need about 10 minutes, SliTaz core
     3.9 -LiveCD expand to 80 Mb so we suggest a minimum of 120 Mb of free space like
    3.10 -this you will be able to install a few more packages. If you can
    3.11 +This document gives information and necessary instructions on how to 
    3.12 +install SliTaz on a hard disk. This should take about 10 minutes, SliTaz core
    3.13 +LiveCD expands to 80 Mb, so we suggest a minimum of 120 Mb of free space. 
    3.14 +That way you will be able to install a few more packages. If you can
    3.15  <a href="livecd.html">use the LiveCD</a>, you should be able to install SliTaz.
    3.16  </p>
    3.17  
    3.18  <a name="installer"></a>
    3.19  <h3>SliTaz Installer</h3>
    3.20  <p>
    3.21 -SliTaz provide a simple to use Installer who can be launch from the 
    3.22 -"System Tools" menu. SliTaz 1.0 Installer messages are only in French and can
    3.23 -be considered as an errata, but English speakers should manage to use it with
    3.24 -this complemantary documentation.
    3.25 +SliTaz provides a simple to use Installer which can be launched from the 
    3.26 +"System Tools" menu. SliTaz 1.0 Installer messages are only available in French
    3.27 +and can be considered as an errata, but English speakers should be able to 
    3.28 +manage to use it with these complimentary instructions.
    3.29  </p>
    3.30  <h4>Install type</h4>
    3.31  <p>
    3.32 -The first step let you choose the type of installation: new install or system 
    3.33 -upgrade. In most case you will want a new and clean installation. When accepted
    3.34 +The first step lets you choose the type of installation: new install or system 
    3.35 +upgrade. In most cases you will want a new and clean installation. Once accepted
    3.36  the installer will mount the master cdrom device and search for the compressed
    3.37 -filesystem (<code>rootfs.gz</code>). If any filesystem was found installation
    3.38 +filesystem (<code>rootfs.gz</code>). If any filesystem was found, then installation
    3.39  will abort.
    3.40  </p>
    3.41  <p>
    3.42  If you get into trouble because the compressed filesystem is not found, please
    3.43 -check that SliTaz is in the master CD/DVD device, if the problem persist you
    3.44 +check that SliTaz is in the master CD/DVD device. If the problem persists you
    3.45  can use a downloaded ISO image and mount it on <code>/media/cdrom</code> where
    3.46 -the HD Installer wanted to find it: 
    3.47 +the HD Installer expects to find it: 
    3.48  </p>
    3.49  <pre>
    3.50   # mount -o loop slitaz-1.0.iso /media/cdrom
    3.51 @@ -75,43 +75,42 @@
    3.52  <h4>Target partition</h4>
    3.53  <p>
    3.54  Second step is the partition configuration. If you have already a free partition
    3.55 -you can directly use it, if not you will have to creat one graphicaly with 
    3.56 +you can directly use it, if not you will have to create one graphically with 
    3.57  Gparted or from the command line with fdisk. For example if you want to install
    3.58  SliTaz on the first partition of the first disk recognized as <code>hda</code>: 
    3.59  </p>
    3.60 -<pre class="script">
    3.61 -/dev/hda1
    3.62 +<pre class="script">/dev/hda1
    3.63  </pre>
    3.64  <h4>Formating</h4>
    3.65  <p>
    3.66 -The next step let you format the target partition into <code>ext3</code>. Ext3
    3.67 +The next step lets you format the target partition into <code>ext3</code>. Ext3
    3.68  is a robust, stable and journalised filesystem. If the partition is already 
    3.69 -formated you dont need to reformat if not just accept. Warning formating a
    3.70 +formated you dont need to reformat, if not just accept. <em>Warning</em> formating a
    3.71  partition will destroy all current data.
    3.72  </p>
    3.73  <h4>Hostname</h4>
    3.74  <p>
    3.75 -Hostname configuration let you set the machine name. The hostname is used 
    3.76 -internaly and to indentify the host on the network. This value can also be
    3.77 +Hostname configuration lets you set the machine name. The hostname is used 
    3.78 +internally to indentify the host on the network. This value can be
    3.79  changed when the system is installed.
    3.80  </p>
    3.81  <h4>Bootloader - GRUB</h4>
    3.82  <p>
    3.83 -When the installation process is finish you have the option to install the GRUB
    3.84 -bootloader who is capable of booting almost all kind of operating system. If
    3.85 +When the installation process is finished you have the option to install the GRUB
    3.86 +bootloader which is capable of booting almost any kind of operating system. If
    3.87  you want to use an existing GRUB installation, skip this step and add the
    3.88  correct lines to your GRUB configuration file (<code>menu.lst</code>). Note 
    3.89 -that SliTaz Installer created a configuration file on the target who can be
    3.90 -used as example (/mnt/target/boot/grub/menu.lst).
    3.91 +that the SliTaz Installer creates a configuration file on the target which can be
    3.92 +used as an example (/mnt/target/boot/grub/menu.lst).
    3.93  </p>
    3.94  <h4>End of installation</h4>
    3.95  <p>
    3.96 -When the Installer did all his job you have the option to exit or directly 
    3.97 -reboot on your new SliTaz GNU/Linux operating system. First boot is like the
    3.98 -LiveCD, you will be prompt for locale, keyboard, sound card and screen 
    3.99 -selection, future reboot will not prompt you anymore for configuration but
   3.100 -all the values can be changed manually or with the project tools such as
   3.101 -<code>tazlocale</code> or <code>tazx</code>.
   3.102 +When the Installer has finally done it's job you have the option to exit or
   3.103 +directly reboot your new SliTaz GNU/Linux operating system. First boot is like
   3.104 +the LiveCD, you will be prompted for locale, keyboard, sound card and screen 
   3.105 +selection. Future reboots will not prompt you anymore for configuration details,
   3.106 +but all the values can be changed either manually or with the project tools 
   3.107 +such as <code>tazlocale</code> or <code>tazx</code>.
   3.108  </p>
   3.109  
   3.110  <a name="byhand"></a>
   3.111 @@ -119,7 +118,7 @@
   3.112  <p>
   3.113  SliTaz can also be installed by hand from the command line. To install SliTaz
   3.114  by hand you can use a cdrom or an ISO image. The given commands can be
   3.115 -copy/past from Firefox to Xterm.
   3.116 +copied/pasted from Firefox to Xterm.
   3.117  </p>
   3.118  <p>
   3.119  The first thing you have to do is prepare a target partition and mount it. 
   3.120 @@ -137,15 +136,15 @@
   3.121   # mount /dev/cdrom /media/cdrom
   3.122  </pre>
   3.123  <p>
   3.124 -Or an ISO image
   3.125 +Or an ISO image:
   3.126  </p>
   3.127  <pre>
   3.128   # mount -o loop slitaz-1.0.iso /media/cdrom
   3.129  </pre>
   3.130  <h4>Install and extract</h4>
   3.131  <p>
   3.132 -The goal now is to copy neede files from the media into the target partition
   3.133 -and then extract the compressed filesystem (<code>rootfs.gz</code>). Creat a
   3.134 +The goal now is to copy needed files from the media into the target partition
   3.135 +and then extract the compressed filesystem (<code>rootfs.gz</code>). Create a
   3.136  boot directory and install the Linux Kernel:
   3.137  </p>
   3.138  <pre>
   3.139 @@ -160,7 +159,7 @@
   3.140  </pre>
   3.141  <p>
   3.142  Now the necessary files are present so you can change directory (<code>cd</code>)
   3.143 -to the target and uncompress the the filesystem with <code>lzma</code> and
   3.144 +to the target and uncompress the filesystem with <code>lzma</code> and
   3.145  <code>cpio</code>:
   3.146  </p>
   3.147  <pre>
   3.148 @@ -169,7 +168,7 @@
   3.149   # rm rootfs.gz init
   3.150  </pre>
   3.151  <p>
   3.152 -That's all, SliTaz is installed. Before rebooting on you new SliTaz GNU/Linux
   3.153 +That's all, SliTaz is installed. Before rebooting on your new SliTaz GNU/Linux
   3.154  installation please check that you have a bootloader (GRUB or Lilo) and add 
   3.155  the necessary lines to boot SliTaz.
   3.156  </p>
   3.157 @@ -177,20 +176,20 @@
   3.158  <a name="grub"></a>
   3.159  <h3>GRUB bootloader</h3>
   3.160  <p>
   3.161 -GRUB is an universal bootloader capable of booting almost all operating such
   3.162 -as Linux, BSD or Windows. GRUB use single configuration file named 
   3.163 -<code>menu.lst</code>, if you used <a href="#installer">SliTaz Installer</a>
   3.164 -and installed GRUB you dont need to install manually GRUB, just reboot.
   3.165 +GRUB is an universal bootloader capable of booting almost any operating system
   3.166 +such as Linux, BSD or Windows. GRUB uses a single configuration file named 
   3.167 +<code>menu.lst</code>, if you used the <a href="#installer">SliTaz Installer</a>
   3.168 +and installed GRUB you dont need to manually install GRUB, just reboot.
   3.169  </p>
   3.170  <p>
   3.171 -Installation of GRUB onto the mbr, using root directory /mnt/target (the taget
   3.172 -mounted partition) and the disk named <code>hda</code>:
   3.173 +Installation of GRUB onto the mbr, using root directory <code>/mnt/target</code>
   3.174 +(the target mounted partition) and the disk named <code>hda</code>:
   3.175  </p>
   3.176  <pre>
   3.177   # grub-install --root-directory=/mnt/target /dev/hda
   3.178  </pre>
   3.179  <p>
   3.180 -You can now creat GRUB configuration file and add the lines who will boot
   3.181 +You can now create a GRUB configuration file and add the lines which will boot
   3.182  SliTaz. Menu.lst can be edited with your favorite text editor such as Nano or
   3.183  Leafpad:
   3.184  </p>
   3.185 @@ -199,11 +198,9 @@
   3.186  </pre>
   3.187  <h4>/boot/grub/menu.lst - Example</h4>
   3.188  <pre class="script">
   3.189 -
   3.190  title  SliTaz GNU/Linux 1.0 (Kernel 2.6.24.2-slitaz)
   3.191         root(hd0,0)
   3.192         kernel /boot/vmlinuz-2.6.24.2-slitaz root=/dev/hda1 vga=normal
   3.193 -
   3.194  </pre>
   3.195  <p>
   3.196  Verify again that everything is in place before rebooting: