aboutsummaryrefslogtreecommitdiff
path: root/snag/readme.txt
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2026-07-22 11:14:54 -0400
committerJack Jamison <jackqjamison@gmail.com>2026-07-22 11:14:54 -0400
commitc293d3cc413991e4fb18b963427a6e55afd2b5c0 (patch)
tree0adc4aba00d9f6497e09c4b77b6017d2cd3bb54a /snag/readme.txt
parent5365f8fa8d6ebfbf3ba92816abe55a99feff6f25 (diff)
organization and url stuff
Diffstat (limited to 'snag/readme.txt')
-rw-r--r--snag/readme.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/snag/readme.txt b/snag/readme.txt
index 33938d6..53df374 100644
--- a/snag/readme.txt
+++ b/snag/readme.txt
@@ -27,16 +27,16 @@ Install Database - the directory containing information on installed packag
Install Description - the data stored about a package in the install database
Download Database - the directory where package downloads are stored and cached
+## Interesting Features
+- switch between cli and tui mode mid run
+- build packages that aren't in the database
+
## Package Description Format
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}`
-## 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
@@ -45,6 +45,9 @@ 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
+### Snag Shell API
+TBD
+
## Install Description Format
TBD. Will contain at least:
- date installed