spk annotate README @ 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 |
| rev | line source |
|---|---|
| pankso@0 | 1 SliTaz Spk |
| pankso@0 | 2 ================================================================================ |
| pankso@0 | 3 |
| pankso@0 | 4 |
| pankso@0 | 5 The SliTaz Spk toolset provide tools and utils to handle SliTaz packages. |
| pankso@0 | 6 |
| pankso@0 | 7 |
| pankso@0 | 8 Spk |
| pankso@0 | 9 ------------------------------------------------------------------------------- |
| pankso@0 | 10 Spk is the main tool to handle and play with SliTaz packages, it handle multiple |
| pankso@0 | 11 packages on cmdline and a wide range of --options wo will perform tasks such as |
| pankso@0 | 12 adding or removing packages using the toolset. Spk itself provide some small |
| pankso@0 | 13 commands such as ls or info. |
| pankso@0 | 14 |
| pankso@0 | 15 |
| pankso@0 | 16 Toolset |
| pankso@0 | 17 ------------------------------------------------------------------------------- |
| pankso@0 | 18 Spk is separated in many small tools follwin the UNIX philosophy: one tool for |
| pankso@0 | 19 one task but do it well. Here is a list of proposal tools and ther functions: |
| pankso@0 | 20 |
| pankso@0 | 21 * spk-add : Install local or online pkgs |
| pankso@0 | 22 * spk-rm : Remove packages: confirm in option ? |
| pankso@0 | 23 * spk-up : Upgrade the all system |
| pankso@0 | 24 * spk-search : Search for packages or files |
| pankso@0 | 25 * spk-... : your turn Christina :-) |
| pankso@0 | 26 |
| pankso@0 | 27 |
| pankso@0 | 28 Devnotes |
| pankso@0 | 29 ------------------------------------------------------------------------------- |
| pankso@0 | 30 |
| pankso@0 | 31 * packages.desc format: package | 1.0 | desc | category | website |
| pankso@0 | 32 * packages.md5 format : de9f76250657000958ee0120d376613e package-1.0.tazpkg |
| pankso@0 | 33 * ... |
| pankso@0 | 34 |
| pankso@0 | 35 |
| pankso@0 | 36 Coding style |
| pankso@0 | 37 -------------------------------------------------------------------------------- |
| pankso@0 | 38 Here are the spk coding style notes, follow them if you want your code included |
| pankso@0 | 39 in the package. These rules are in addition to cookutils coding style, please |
| pankso@0 | 40 read also cookutils/README |
| pankso@0 | 41 |
| pankso@0 | 42 |
| pankso@0 | 43 * No bash, be Busybox Ash compatible |
| pankso@0 | 44 * Use libtaz.sh, slitaz.conf and libpkg.sh |
| pankso@0 | 45 * ... |
| pankso@0 | 46 |
| pankso@0 | 47 ================================================================================ |
| pankso@0 | 48 |