spk view README @ rev 7

Add: AUTHORS (empty) and COPYING
author Christophe Lincoln <pankso@slitaz.org>
date Fri May 11 16:35:54 2012 +0200 (2012-05-11)
parents 18c3408dec16
children 8517989e8588
line source
1 SliTaz Spk
2 ================================================================================
5 The SliTaz Spk toolset provide tools and utils to handle SliTaz packages.
8 Spk
9 -------------------------------------------------------------------------------
10 Spk is the main tool to handle and play with SliTaz packages, it handles multiple
11 packages on cmdline and a wide range of --options which will perform tasks such
12 as adding or removing packages using the toolset. Spk itself provides some small
13 commands such as ls or info.
16 Toolset
17 -------------------------------------------------------------------------------
18 Spk is separated in many small tools following the UNIX philosophy: one tool for
19 one task but do that task well. Here is a list of proposal tools and ther
20 functions:
22 * spk-add : Install local or online pkgs
23 * spk-rm : Remove packages: confirm in option ?
24 * spk-up : Upgrade the all system
25 * spk-search : Search for packages or files
26 * spk-archive: Manage pacakge extraction, compression, and packing
27 * spk-mirror : Manage mirrors and undigest
30 LibSpk
31 -------------------------------------------------------------------------------
32 Libspk provide base function and internal variables used my almost all spk-tools.
34 * Source: libtaz.sh, libpkg.sh, slitaz.conf
35 * Internal Spk variables (lowercase, not configurable)
36 * Display package info
37 * ...
40 Devnotes
41 -------------------------------------------------------------------------------
42 Some random and usefull notes.
44 * packages.desc format: package | 1.0 | desc | category | website
45 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg
46 * ...
48 Since we use latest libtaz.sh, slitaz.conf and libpkg.sh code you must install
49 these files to develop the Spk Toolset:
51 $ hg clone http://hg.slitaz.org/slitaz-base-files
52 $ cd slitaz-base-files
53 $ make install-libtaz
54 $ make install-libpkg
55 $ make install-slitaz
58 Coding style
59 --------------------------------------------------------------------------------
60 Here are the spk coding style notes, follow them if you want your code included
61 in the package. These rules are in addition to cookutils coding style, please
62 read also cookutils/README
65 * No bash, be Busybox Ash compatible
66 * Use libtaz.sh, slitaz.conf and libpkg.sh
67 * ...
69 ================================================================================