diff options
Diffstat (limited to 'snag/readme.txt')
| -rw-r--r-- | snag/readme.txt | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/snag/readme.txt b/snag/readme.txt index 5e3fd9a..33938d6 100644 --- a/snag/readme.txt +++ b/snag/readme.txt @@ -13,7 +13,8 @@ why - list why this package is installed (manually installed, as a depe ## Important Directories Package Database - /var/snag/pkgs/ -Install Database - /var/snag/install/ +Install Database - /var/snag/state/ +Download Database - /var/snag/downloads/ Logs/In Progress Builds - /var/snag/builds/ SNAG Configuration - /etc/snag/ @@ -24,6 +25,7 @@ Package Info/Metadata - the metadata encoded in the package description Package Attribute - a single key value property of the package info Install Database - the directory containing information on installed package Install Description - the data stored about a package in the install database +Download Database - the directory where package downloads are stored and cached ## Package Description Format Each package has a directory in the package database, named by its `id`. @@ -31,21 +33,23 @@ Inside each package directory is the description script named `{id}.sh` The description script should have functions for `configure`, `build`, and `install` The description script should define variables for attributes with the name `pkg_{attr}` -## Install Description Format -TBD. Will contain at least: -- date installed -- flists -- install reason - - ## Interesting Features - switch between cli and tui mode mid run - build packages that aren't in the database Packages have the following attributes: -`id` - the identifier name of the package. everything uses this -`name` - the display name of package -`desc` - the short description of the package +id - the identifier name of the package. everything uses this +name - the display name of package +desc - the short description of the package +webpage - url to home website +license - spdx identifer for package license (https://spdx.org/licenses/) +version - software version, in whatever format is needed. commit hashes are allowed + +## Install Description Format +TBD. Will contain at least: +- date installed +- flists +- install reason ## Developer Subcommands `validate` - check a package description and check for format errors or warnings |