slitaz-arm annotate README @ rev 58

Bunch og new stuff: more doc, st fixes, tazberry
author Christophe Lincoln <pankso@slitaz.org>
date Sat Mar 15 14:54:17 2014 +0100 (2014-03-15)
parents 9199cafc01e0
children dd6fa65acfc2
rev   line source
pankso@0 1 SliTaz ARM
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
paul@17 5 SliTaz ARM tools and files
pankso@0 6
pankso@0 7
pankso@58 8 Build tools installation
pankso@35 9 --------------------------------------------------------------------------------
pankso@58 10 To install 'sat' and 'sat-rpi' you need to have make installed or copy the 2
pankso@58 11 files to /usr/bin:
pankso@35 12
pankso@35 13 # make install
pankso@35 14
pankso@35 15
pankso@35 16 Sat quickstart
pankso@35 17 --------------
paul@51 18 Sat is a tool in the spirit of all SliTaz tools, all commands and options are
pankso@10 19 accessible via: sat usage or help. To create a distro you first need to have
pankso@24 20 some ARM packages. You can use custom cook or the one from the SliTaz mirror.
pankso@24 21 Put all your custom *.tazpkg in the packages/ directory and sat will install
pankso@24 22 them. To use the official packages you need to sync the mirror with:
pankso@10 23
pankso@24 24 # sat mirror
pankso@24 25
pankso@24 26 Generate the distro initramfs with your custom --options:
pankso@24 27
pankso@24 28 # sat gen --flavor=base --kmap
pankso@10 29
pankso@10 30 To boot the distro with Qemu you can run:
pankso@10 31
pankso@10 32 # sat emu
pankso@10 33
pankso@24 34
pankso@58 35 ARM packages mirror
pankso@35 36 --------------------------------------------------------------------------------
pankso@24 37 Sat lets you clone the ARM cooking mirror to let you debug and try official ARM
paul@17 38 packages. Sat will create a mirror directory in the working path and download
paul@17 39 all lists and packages. After a first clone it will only check the repo ID
paul@17 40 file and download any modified or new packages.
pankso@2 41
pankso@2 42
pankso@58 43 Custom SliTaz system files: rootfs/
pankso@58 44 --------------------------------------------------------------------------------
pankso@58 45 Custom SliTaz ARM scripts and files used to generate a distro. These files
pankso@58 46 and any other system files can be erased or added via the flavors support. The
pankso@58 47 rootfs files can also be directly modified before generating a new distro.
pankso@58 48
pankso@58 49
pankso@58 50 CGI Admin web interface: cgi-adm/
pankso@58 51 --------------------------------------------------------------------------------
pankso@58 52 Very small and fast CGI SHell admin/info web interface for ARM devices with
pankso@58 53 plugins support. The goal is not to rewrite TazPanel but to have a light CGI
pankso@58 54 toolkit to code specific ARM devices plugings such as boot configs for the
pankso@58 55 Raspberry Pi. In the plugins directory you will find the a skeleton to start
pankso@58 56 your custom plugin. You can also create general purpose or hardware specific
pankso@58 57 plugins.
pankso@58 58
pankso@58 59 The root directory is: /var/www/adm and the default web server is Busyboy HTTPd.
pankso@58 60 So just start the web server and connect to the IP address of your machine:
pankso@58 61
pankso@58 62 # stard httpd
pankso@58 63
pankso@58 64 URL form: http://192.rpi.ip/adm/
pankso@58 65
pankso@58 66 On SliTaz i486 you can also use Busybox HTTPd and install the cgi-adm files
pankso@58 67 under /var/www and code directly then copy or upload you plugin to your ARM
pankso@58 68 devices.
pankso@58 69
pankso@58 70 # make install-cgi
pankso@58 71
pankso@58 72
pankso@24 73 Bugs
pankso@35 74 --------------------------------------------------------------------------------
paul@29 75 Please report bugs on the Slitaz Bug Tracker: http://bugs.slitaz.org/
pankso@24 76
pankso@24 77
pankso@0 78 History
pankso@35 79 --------------------------------------------------------------------------------
paul@17 80 While I was porting SliTaz to ARM I ended up by creating a lot of initramfs'
paul@17 81 to test the SliTaz boot, packages and so on. So I first wrote a small script,
paul@17 82 then improved it by just having to put include packages in a single directory
pankso@2 83 and all custom files in a rootfs directory. I also wanted virtual disk support
paul@17 84 so I can code under Qemu and save my work. This is how sat was born, one day
paul@17 85 we may use TazLito or have a new SliTaz Live tool, but for the time being 'sat'
paul@17 86 and the way it works fits all my needs to build custom distros and then boot
pankso@2 87 with qemu-system-arm.
pankso@0 88
pankso@0 89 - Pankso 24 May 2012
pankso@0 90
pankso@0 91
pankso@0 92 ================================================================================