spk rev 0

First commit with the README
author Christophe Lincoln <pankso@slitaz.org>
date Fri May 11 15:40:08 2012 +0200 (2012-05-11)
parents
children 8f84351554c5
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Fri May 11 15:40:08 2012 +0200
     1.3 @@ -0,0 +1,48 @@
     1.4 +SliTaz Spk
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +The SliTaz Spk toolset provide tools and utils to handle SliTaz packages.
     1.9 +
    1.10 +
    1.11 +Spk
    1.12 +-------------------------------------------------------------------------------
    1.13 +Spk is the main tool to handle and play with SliTaz packages, it handle multiple
    1.14 +packages on cmdline and a wide range of --options wo will perform tasks such as
    1.15 +adding or removing packages using the toolset. Spk itself provide some small
    1.16 +commands such as ls or info.
    1.17 +
    1.18 +
    1.19 +Toolset
    1.20 +-------------------------------------------------------------------------------
    1.21 +Spk is separated in many small tools follwin the UNIX philosophy: one tool for
    1.22 +one task but do it well. Here is a list of proposal tools and ther functions:
    1.23 +
    1.24 +	* spk-add    : Install local or online pkgs
    1.25 +	* spk-rm     : Remove packages: confirm in option ?
    1.26 +	* spk-up     : Upgrade the all system
    1.27 +	* spk-search : Search for packages or files
    1.28 +	* spk-...    : your turn Christina :-)
    1.29 +
    1.30 +
    1.31 +Devnotes
    1.32 +-------------------------------------------------------------------------------
    1.33 +
    1.34 +	* packages.desc format: package | 1.0 | desc | category | website
    1.35 +	* packages.md5 format : de9f76250657000958ee0120d376613e  package-1.0.tazpkg
    1.36 +	* ...
    1.37 +
    1.38 +
    1.39 +Coding style
    1.40 +--------------------------------------------------------------------------------
    1.41 +Here are the spk coding style notes, follow them if you want your code included
    1.42 +in the package. These rules are in addition to cookutils coding style, please
    1.43 +read also cookutils/README
    1.44 +
    1.45 +
    1.46 +    * No bash, be Busybox Ash compatible
    1.47 +    * Use libtaz.sh, slitaz.conf and libpkg.sh
    1.48 +	* ...
    1.49 +
    1.50 +================================================================================
    1.51 +