diff options
Diffstat (limited to 'snag/readme.txt')
| -rw-r--r-- | snag/readme.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/snag/readme.txt b/snag/readme.txt index d93431d..6062924 100644 --- a/snag/readme.txt +++ b/snag/readme.txt @@ -11,6 +11,12 @@ `log` - open your pager to the build log of the specified package `why` - list why this package is installed (manually installed, as a dependency, from a group) +## Important Directories +Package Database - /var/snag/pkgs/ +Install Database - /var/snag/install/ +Logs/In Progress Builds - /var/snag/logs/ +SNAG Configuration - /etc/snag/ + ## Terminology "Package Database" - the directory containing package descriptions "Install Database" - the directory containing information on installed package @@ -23,16 +29,15 @@ Each package has a directory in the package database, named by its `id`. 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}` -> We're still deciding if we want the metadata to be split from the instruction in separate file(s). + +## 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 -## Interesting Features -- switch between cli and tui mode mid run -- build packages that aren't in the database - ## Developer Subcommands `validate` - check a package description and check for format errors or warnings |