Skip to content

Commit 4f8d39e

Browse files
committed
docs(readme): describe Unix shell framework and tested platforms
1 parent eaae523 commit 4f8d39e

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Guidelines
22

3-
`shellbase` is a POSIX-oriented shell framework (`lib/base.sh`) that scripts
4-
source for logging, validation, signal handling, garbage collection, and
5-
concurrent-instance support.
3+
`shellbase` is a Unix shell framework (`lib/base.sh`) for logging, validation,
4+
signal handling, garbage collection, and concurrent instances.
5+
It follows POSIX, the Portable Operating System Interface, and runs on any
6+
Unix-like system.
7+
Sourcing it gives a script a set of global variables and functions.
68
Read the shared rules at
79
https://raw.githubusercontent.com/rdavid/prompt/master/README.txt
810
before starting any task, unless they are already loaded.
@@ -27,8 +29,8 @@ This project uses `redo` (or `goredo`) as the primary task runner.
2729

2830
- `redo all`: run the default build target.
2931
- `redo lint`: run `actionlint`, `agent-rules-lint`, `checkmake`, `conform`,
30-
`dash`, `hadolint`, `mksh`, `reuse`, `shellcheck`, `shfmt`, `typos`, `vale`,
31-
`yamllint`, and `zizmor`.
32+
`dash`, `gitleaks`, `hadolint`, `mksh`, `reuse`, `shellcheck`, `shfmt`,
33+
`typos`, `vale`, `yamllint`, and `zizmor`.
3234
- `redo test`: execute unit tests against the shells installed locally.
3335
- `redo test-container`: run the test suite inside the supported container
3436
images.

‎README.adoc‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,17 @@ endif::[]
9090

9191
== About
9292

93-
`shellbase` is a POSIX shell framework for logging, validation, signal
93+
`shellbase` is a Unix shell framework for logging, validation, signal
9494
handling, garbage collection, and concurrent instances.
95-
It runs on any Unix-like system.
95+
It follows POSIX, the Portable Operating System Interface, and runs on any
96+
Unix-like system.
97+
Continuous integration tests it on FreeBSD, macOS, and Linux distributions
98+
such as Alpine, Arch Linux, Debian, Fedora, and Red Hat UBI.
9699
ifndef::pages-build[]
97100
The framework also has a {url-pages}[website].
98101
endif::[]
99102

100-
`shellbase` defines global variables and functions.
103+
Sourcing `shellbase` gives a script a set of global variables and functions.
101104
Clients may call any function without the `base_` prefix.
102105
The public functions are, in alphabetical order:
103106
{url-base}#L71[`aud_only`],

0 commit comments

Comments
 (0)