aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAliaksei Urbanski <aliaksei.urbanski@gmail.com>2023-11-08 18:08:15 +0300
committerSam James <sam@gentoo.org>2023-11-13 06:20:51 +0000
commitb599daf14eda0a238265f11d239c4c772c345fbd (patch)
treedba162893a79a8df26e382c88929941c4b6a3d1b
parentAdd a GitHub Actions workflow for tests (diff)
downloadpambase-b599daf14eda0a238265f11d239c4c772c345fbd.tar.gz
pambase-b599daf14eda0a238265f11d239c4c772c345fbd.tar.bz2
pambase-b599daf14eda0a238265f11d239c4c772c345fbd.zip
Add README.md
Closes: https://github.com/gentoo/pambase/pull/18 Signed-off-by: Sam James <sam@gentoo.org>
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59f4ecd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# pambase
+
+[PAM](https://wiki.gentoo.org/wiki/PAM) base configuration files.
+
+This repository contains a small [Python](https://wiki.gentoo.org/wiki/Python) script that renders `PAM` configuration templates for [Gentoo Linux](https://www.gentoo.org).
+
+## Dependencies
+
+`pambase` depends on [jinja](https://packages.gentoo.org/packages/dev-python/jinja).
+
+## Testing
+
+In order to perform tests, run [tox](https://packages.gentoo.org/packages/dev-python/tox).
+
+Alternatively, you can run tests with [Docker](https://wiki.gentoo.org/wiki/Docker):
+```sh
+docker run --rm -it $(docker build -q .)
+```