seb annotate README @ rev 1

Add README file with devel documentation
author Christophe Lincoln <pankso@slitaz.org>
date Mon Mar 06 00:54:48 2017 +0100 (2017-03-06)
parents
children a4fa34b33e9e
rev   line source
pankso@1 1 SEB - SliTaz Embedded OS
pankso@1 2 ================================================================================
pankso@1 3
pankso@1 4 Back to the root with this cmdline tool to build realy small SliTaz textmode
pankso@1 5 system for hacking, learning and developing small Linux operating system.
pankso@1 6
pankso@1 7 Seb builder will init a minimal set of files that you can customise at your
pankso@1 8 needs, install Busybox and create a compressed rootfs that can boot in frugal
pankso@1 9 mode as well as an ISO image to use with Qemu. Other boot methods can be used
pankso@1 10 with a bit a knowledge (web boot). The system is built in a single rootfs
pankso@1 11 folder wich can be used as chroot environment.
pankso@1 12
pankso@1 13 SliTaz embedded provide all basic Linux command, a powerfull web server with
pankso@1 14 CGI support and a set of home made tools for administration and debuging. Seb
pankso@1 15 is easy too use, follow the KISS principle. Please use SliTaz Bugs System
pankso@1 16 for any bug report. There is no wifi support and it's not bug :-)
pankso@1 17
pankso@1 18 If you want to learn more about the basics of a Linux operating system you
pankso@1 19 can have a look to SliTaz Scratchbook wich explain step by step the creation of
pankso@1 20 SliTaz back in 2006. This tool was published in 2017, ten years after the first
pankso@1 21 cooking public release :-)
pankso@1 22
pankso@1 23 Seb system will fit into a ~4MB ISO image for the realy base system, up to 10Mb
pankso@1 24 or more, but without X. If you are seraching for an even more small SliTaz
pankso@1 25 version, please have a look to Tiny SliTaz: http://tiny.slitaz.org
pankso@1 26
pankso@1 27
pankso@1 28 Goals and features
pankso@1 29 -------------------------------------------------------------------------------
pankso@1 30
pankso@1 31 * Built fast and light servers or mediabox
pankso@1 32 * Nice way to learn about creating Linux OS
pankso@1 33 * Built small rescue systems in frugal mode
pankso@1 34 * Fun playground for hackers and kids
pankso@1 35
pankso@1 36
pankso@1 37 Quickstart Guide:
pankso@1 38 --------------------------------------------------------------------------------
pankso@1 39 Build a distro in a few commands. Install seb or run it from source tree. After the
pankso@1 40 init command you can modify and add extra files in the embfs/ folder:
pankso@1 41
pankso@1 42 # mkdir my-seb; cd my-seb
pankso@1 43 # seb init
pankso@1 44 # seb -p sqlite --add
pankso@1 45 # seb build
pankso@1 46
pankso@1 47
pankso@1 48 Build process & environment
pankso@1 49 --------------------------------------------------------------------------------
pankso@1 50 Seb is not compliling any tools, it will use Slitaz standard executable and
pankso@1 51 libraries - Seb-os is created on top of SliTaz. Packages installed in seb must
pankso@1 52 be on the build host, this is the case for the full basic sysem.
pankso@1 53
pankso@1 54 Seb will build the custom operating system into the current directory or it
pankso@1 55 will read a seb.conf file to know the path to the work/build folder. Seb will
pankso@1 56 use these directories to work:
pankso@1 57
pankso@1 58 * rootfs/ The root filsysytem of the compressed operationg system
pankso@1 59 * rootiso/ Root of the ISO image with rootfs.gz, bootloader and kernel
pankso@1 60 * sebfs/ Custom files overwritting file into the rootfs
pankso@1 61 * sebpkgs/ The packages to install into the distro
pankso@1 62
pankso@1 63
pankso@1 64 Frugal install
pankso@1 65 --------------------------------------------------------------------------------
pankso@1 66 A frugal installation let you boot your seb system without any installation and
pankso@1 67 with the all system running in memory. Basicaly you need to have the rootfs.gz
pankso@1 68 and the kernel in the /boot tree and a entry in Grub configuration file. SliTaz
pankso@1 69 provide a nifty little tools for frugal install:
pankso@1 70
pankso@1 71 # frugal path/to/image.iso
pankso@1 72
pankso@1 73
pankso@1 74 Virtual disk
pankso@1 75 --------------------------------------------------------------------------------
pankso@1 76 A virtual disk let you have a persitstant filesystem when using Qemu or booting,
pankso@1 77 in frugal mode (recommended). It is useful when developping/debugging scripts
pankso@1 78 that runs into a seb-os or to host web server virtual hosts. Create, mount or
pankso@1 79 umount disk:
pankso@1 80
pankso@1 81 # seb disk
pankso@1 82
pankso@1 83
pankso@1 84 Source code and devel guidelines
pankso@1 85 --------------------------------------------------------------------------------
pankso@1 86 Note even need to say that this tool MUST stay simple, fast, elegant and fun.
pankso@1 87 We dont want a super tool for complex system building, we have tazlito and Tiny
pankso@1 88 SliTaz for that. Seb is as close as possible of SliTaz first build, seb is
pankso@1 89 also a learning tool. Seb let you build sandbox os and rock solid web server.
pankso@1 90
pankso@1 91 * examples/ Various fs and scripts examples
pankso@1 92 * initfs/ Initial files used to create the system
pankso@1 93 * seb SliTaz Embedded operation system builder
pankso@1 94 * tools/ Various tools included or used to build an OS
pankso@1 95 * packages/ SliTaz Embedded packages
pankso@1 96
pankso@1 97
pankso@1 98 Gettext i18n
pankso@1 99 --------------------------------------------------------------------------------
pankso@1 100 No i18n with gettext in seb tools since seb distro dont include gettext-base.
pankso@1 101
pankso@1 102
pankso@1 103 ================================================================================