commit:     b599daf14eda0a238265f11d239c4c772c345fbd
Author:     Aliaksei Urbanski <aliaksei.urbanski <AT> gmail <DOT> com>
AuthorDate: Wed Nov  8 15:08:15 2023 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Mon Nov 13 06:20:51 2023 +0000
URL:        https://gitweb.gentoo.org/proj/pambase.git/commit/?id=b599daf1

Add README.md

Closes: https://github.com/gentoo/pambase/pull/18
Signed-off-by: Sam James <sam <AT> gentoo.org>

 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

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 .)
+```

Reply via email to