seb diff 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 |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/README Mon Mar 06 00:54:48 2017 +0100 1.3 @@ -0,0 +1,103 @@ 1.4 +SEB - SliTaz Embedded OS 1.5 +================================================================================ 1.6 + 1.7 +Back to the root with this cmdline tool to build realy small SliTaz textmode 1.8 +system for hacking, learning and developing small Linux operating system. 1.9 + 1.10 +Seb builder will init a minimal set of files that you can customise at your 1.11 +needs, install Busybox and create a compressed rootfs that can boot in frugal 1.12 +mode as well as an ISO image to use with Qemu. Other boot methods can be used 1.13 +with a bit a knowledge (web boot). The system is built in a single rootfs 1.14 +folder wich can be used as chroot environment. 1.15 + 1.16 +SliTaz embedded provide all basic Linux command, a powerfull web server with 1.17 +CGI support and a set of home made tools for administration and debuging. Seb 1.18 +is easy too use, follow the KISS principle. Please use SliTaz Bugs System 1.19 +for any bug report. There is no wifi support and it's not bug :-) 1.20 + 1.21 +If you want to learn more about the basics of a Linux operating system you 1.22 +can have a look to SliTaz Scratchbook wich explain step by step the creation of 1.23 +SliTaz back in 2006. This tool was published in 2017, ten years after the first 1.24 +cooking public release :-) 1.25 + 1.26 +Seb system will fit into a ~4MB ISO image for the realy base system, up to 10Mb 1.27 +or more, but without X. If you are seraching for an even more small SliTaz 1.28 +version, please have a look to Tiny SliTaz: http://tiny.slitaz.org 1.29 + 1.30 + 1.31 +Goals and features 1.32 +------------------------------------------------------------------------------- 1.33 + 1.34 + * Built fast and light servers or mediabox 1.35 + * Nice way to learn about creating Linux OS 1.36 + * Built small rescue systems in frugal mode 1.37 + * Fun playground for hackers and kids 1.38 + 1.39 + 1.40 +Quickstart Guide: 1.41 +-------------------------------------------------------------------------------- 1.42 +Build a distro in a few commands. Install seb or run it from source tree. After the 1.43 +init command you can modify and add extra files in the embfs/ folder: 1.44 + 1.45 + # mkdir my-seb; cd my-seb 1.46 + # seb init 1.47 + # seb -p sqlite --add 1.48 + # seb build 1.49 + 1.50 + 1.51 +Build process & environment 1.52 +-------------------------------------------------------------------------------- 1.53 +Seb is not compliling any tools, it will use Slitaz standard executable and 1.54 +libraries - Seb-os is created on top of SliTaz. Packages installed in seb must 1.55 +be on the build host, this is the case for the full basic sysem. 1.56 + 1.57 +Seb will build the custom operating system into the current directory or it 1.58 +will read a seb.conf file to know the path to the work/build folder. Seb will 1.59 +use these directories to work: 1.60 + 1.61 + * rootfs/ The root filsysytem of the compressed operationg system 1.62 + * rootiso/ Root of the ISO image with rootfs.gz, bootloader and kernel 1.63 + * sebfs/ Custom files overwritting file into the rootfs 1.64 + * sebpkgs/ The packages to install into the distro 1.65 + 1.66 + 1.67 +Frugal install 1.68 +-------------------------------------------------------------------------------- 1.69 +A frugal installation let you boot your seb system without any installation and 1.70 +with the all system running in memory. Basicaly you need to have the rootfs.gz 1.71 +and the kernel in the /boot tree and a entry in Grub configuration file. SliTaz 1.72 +provide a nifty little tools for frugal install: 1.73 + 1.74 + # frugal path/to/image.iso 1.75 + 1.76 + 1.77 +Virtual disk 1.78 +-------------------------------------------------------------------------------- 1.79 +A virtual disk let you have a persitstant filesystem when using Qemu or booting, 1.80 +in frugal mode (recommended). It is useful when developping/debugging scripts 1.81 +that runs into a seb-os or to host web server virtual hosts. Create, mount or 1.82 +umount disk: 1.83 + 1.84 + # seb disk 1.85 + 1.86 + 1.87 +Source code and devel guidelines 1.88 +-------------------------------------------------------------------------------- 1.89 +Note even need to say that this tool MUST stay simple, fast, elegant and fun. 1.90 +We dont want a super tool for complex system building, we have tazlito and Tiny 1.91 +SliTaz for that. Seb is as close as possible of SliTaz first build, seb is 1.92 +also a learning tool. Seb let you build sandbox os and rock solid web server. 1.93 + 1.94 + * examples/ Various fs and scripts examples 1.95 + * initfs/ Initial files used to create the system 1.96 + * seb SliTaz Embedded operation system builder 1.97 + * tools/ Various tools included or used to build an OS 1.98 + * packages/ SliTaz Embedded packages 1.99 + 1.100 + 1.101 +Gettext i18n 1.102 +-------------------------------------------------------------------------------- 1.103 +No i18n with gettext in seb tools since seb distro dont include gettext-base. 1.104 + 1.105 + 1.106 +================================================================================