kiss-community/kiss
1
0
Fork 1
mirror of https://codeberg.org/kiss-community/kiss synced 2024-07-02 14:02:26 +00:00
Code Issues Wiki

docs: update

Browse Source
This commit is contained in:
Dylan Araps 2020-05-15 11:08:04 +03:00
parent 9433fcd7c3
commit ed623bcd83
No known key found for this signature in database
GPG Key ID: 46D62DD9F1DE636E
1 changed files with 21 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -3,6 +3,7 @@
Tiny and straightforward package manager for KISS written in POSIX `sh`. Tiny and straightforward package manager for KISS written in POSIX `sh`.
- Less than 1000 lines of POSIX `sh` (excluding blank lines and comments). - Less than 1000 lines of POSIX `sh` (excluding blank lines and comments).
- Highly portable (will run in any POSIX compliant environment).
- Runtime dependency detection. - Runtime dependency detection.
- Incremental package installation. - Incremental package installation.
- Fast dependency solver. - Fast dependency solver.
@ -30,49 +31,26 @@ Tiny and straightforward package manager for KISS written in POSIX `sh`.
## Dependencies / Portability ## Dependencies / Portability
```sh | --------------- | ---------------------------- | ----------------- |
# - Anything with a specification should follow it (POSIX, BSD, etc). | dependency | why | mandatory? |
# - Anything without a specification which has ONLY a single (widely used) | --------------- | ---------------------------- | ----------------- |
# implementation will be considered portable (git, curl, etc). | POSIX utilities | | Yes |
# | `git` | repositories and git sources | Yes |
# POSIX utilities | `gnupg1` or `gnupg2` | Repository signing | No (optional) |
# - sh (POSIX) | `curl` | Source downloads | Yes |
# - find (POSIX) -type f, -type d, -exec {} [+;], -o, -print, ! | `sha256sum`, `shasum`, `sha256` or `openssl` | Checksum verification | Yes |
# - ls (POSIX) -l, -d | `tar` | Tarball creation/extraction | Yes |
# - sed (POSIX) -n, s/<search>/<replace>/g, /<delete>/d | `bzip2` | Compression method. | Yes (widely used) |
# - grep (POSIX) -l, -F, -x, -f, -q, -v | `xz` | Compression method. | Yes (widely used) |
# - sort (POSIX) -r, -u, -k | `gzip` | Compression method. | Yes (widely used) |
# - tee (POSIX) -a | `zstd` | Compression method. | No (rarely used) |
# - date (POSIX) | `lzma` | Compression method. | No (rarely used) |
# - mkdir (POSIX) -p | `lzip` | Compression method. | No (rarely used) |
# - rm (POSIX) -f, -r | `unzip` | Source type. | No (rarely used) |
# - rmdir (POSIX) | `su`, `sudo` or `doas` | Privilege escalation. | No (optional) |
# - cp (POSIX) -f, -P, -p, -L, -R | `ldd` | Automatic dependency fixer. | No (optional) |
# - mv (POSIX) -f | `readelf` and `strip` | Binary stripping | No (optional) |
# - chown (POSIX) -h
# - diff (POSIX) -U
#
# Misc
# - su* (sudo, doas, su) (in order, optional)
# - git (downloads from git) (must link to curl)
# - curl (downloads over http) (also needed by git)
# - sha256 (multiple fallbacks: sha256sum, shasum, sha256, openssl, etc)
#
# Compiler/libc utilities (depends cc & libc)
# - readelf (optional) (Part of compiler toolchain) (GNU, LLVM or elfutils)
# - strip (optional) (Part of compiler toolchain) (GNU, LLVM or elfutils)
# - ldd (optional) (Part of libc)
#
# Tarball compression
# - tar (as portable as can be) (merely: cf, tf, xf)
# - bzip2 (widely used) -d, -z
# - xz (widely used) -d, -z, -c, -T
# - gzip (widely used) -d, -6
# - zstd (optional) -d, -z, -c
# - unzip (optional)
# - lzma (optional)
# - lzip (optional)
```
## Package format ## Package format