seb rev 12

Improve README/manual
author Christophe Lincoln <pankso@slitaz.org>
date Mon Mar 06 20:08:52 2017 +0100 (2017-03-06)
parents d28b86ae0e45
children 212ea6d3ec20
files README seb
line diff
     1.1 --- a/README	Mon Mar 06 19:06:12 2017 +0100
     1.2 +++ b/README	Mon Mar 06 20:08:52 2017 +0100
     1.3 @@ -36,14 +36,21 @@
     1.4  
     1.5  Quickstart Guide:
     1.6  --------------------------------------------------------------------------------
     1.7 -Build a distro in a few commands. Install seb or run it from source tree. After the
     1.8 -init command you can modify and add extra files in the embfs/ folder:
     1.9 +Build a distro in a few commands. Install seb or run it from source tree:
    1.10  
    1.11 -  # mkdir my-seb; cd my-seb
    1.12 +  # mkdir seb-os; cd seb-os
    1.13    # seb init
    1.14 +
    1.15 +You can now modify and add extra files in the embfs/ folder. Let's include
    1.16 +sqlite package and build the ISO image:
    1.17 +
    1.18    # seb -p sqlite --add
    1.19    # seb build
    1.20  
    1.21 +If you want to test the OS, you can install Qemu emulator and run:
    1.22 +
    1.23 +  # seb -e
    1.24 +
    1.25  To get a list of commands, just run seb without arguments: $ seb
    1.26  
    1.27  
    1.28 @@ -63,6 +70,30 @@
    1.29    * sebpkgs/    The packages to install into the distro
    1.30  
    1.31  
    1.32 +Linux kernel and modules
    1.33 +-------------------------------------------------------------------------------
    1.34 +By default seb will use the running kernel and a custom one can be used with
    1.35 +the option --linux= or with a build.conf file. There is no kernel modules
    1.36 +support in seb, it would mean having kmod, liblzma, zlib and a bunch of files
    1.37 +in /lib/modules. This is not what we want in a small customized OS. To be fast
    1.38 +at boot we rommended you to build your own linux kernel with SliTaz utils or
    1.39 +from source like expained in the Scratchbook with modules built-in the kernel.
    1.40 +
    1.41 +To use a custom Linux kernel with seb builder:
    1.42 +
    1.43 +  # seb build --linux=/path/to/bzImage
    1.44 +
    1.45 +To cook a custom kernel with SliTaz cookutils:
    1.46 +
    1.47 +  # cooklinux usage
    1.48 +  
    1.49 +After the kernel is built, you will have a SliTaz packages and all generated
    1.50 +files in /home/slitaz/src/linux-XXX. The kernel compressed image (bzImage) can
    1.51 +be found inthe arch/folder. Example for linux 4.9.10 build for X86 platform:
    1.52 +
    1.53 +/home/slitaz/src/linux-4.9.10/arch/x86/boot/bzImage
    1.54 +
    1.55 +
    1.56  Frugal install
    1.57  --------------------------------------------------------------------------------
    1.58  A frugal installation let you boot your seb system without any installation and
    1.59 @@ -77,7 +108,7 @@
    1.60  # Seb OS Frugal on sdb1
    1.61  title SliTaz Embedded OS (frugal)
    1.62  root (hd0,0)
    1.63 -kernel /boot/frugal/bzImage root=/dev/null rdinit=/sbin/init
    1.64 +kernel /boot/frugal/bzImage root=/dev/null rdinit=/sbin/init loglevel=5
    1.65  initrd /boot/frugal/rootfs.gz
    1.66  
    1.67  
    1.68 @@ -91,12 +122,13 @@
    1.69    # seb disk
    1.70  
    1.71  
    1.72 -Source code and devel guidelines
    1.73 +Source code and developers guidelines
    1.74  --------------------------------------------------------------------------------
    1.75  Note even need to say that this tool MUST stay simple, fast, elegant and fun.
    1.76  We dont want a super tool for complex system building, we have tazlito and Tiny
    1.77  SliTaz for that. Seb is as close as possible of SliTaz first build, seb is
    1.78 -also a learning tool. Seb let you build sandbox os and rock solid web server.
    1.79 +also a learning tool. Seb let you build sandbox os from scratch and rock solid 
    1.80 +hardware specific servers.
    1.81  
    1.82    * examples/       Various fs and scripts examples
    1.83    * initfs/         Initial files used to create the system
    1.84 @@ -105,8 +137,8 @@
    1.85    * tools/          Various tools included or used to build an OS
    1.86    * packages/       SliTaz Embedded packages database
    1.87  
    1.88 -We dont want to much automation, let people create ther own OS in there
    1.89 -own way but provide some usefull function to help :-)
    1.90 +We dont want to much automation, let people create ther own OS in there own way
    1.91 +but provide some usefull function to help :-)
    1.92    
    1.93  
    1.94  Gettext i18n
     2.1 --- a/seb	Mon Mar 06 19:06:12 2017 +0100
     2.2 +++ b/seb	Mon Mar 06 20:08:52 2017 +0100
     2.3 @@ -55,6 +55,7 @@
     2.4  $(colorize 35 "SliTaz Embedded Builder")
     2.5  
     2.6  $(boldify "Usage:") $(basename $0) [command] [--opts]
     2.7 +$(boldify "Manuel:") man seb
     2.8  
     2.9  $(boldify "Commands:")
    2.10    -h  help       Display this short built-in help
    2.11 @@ -300,7 +301,7 @@
    2.12  default seb
    2.13  label seb
    2.14  	kernel /boot/bzImage
    2.15 -	append initrd=/boot/rootfs.gz rw root=/dev/null rdinit=/sbin/init
    2.16 +	append initrd=/boot/rootfs.gz rw root=/dev/null rdinit=/sbin/init loglevel=5
    2.17  implicit 0
    2.18  prompt 1
    2.19  timeout 40