summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Steinert <[email protected]>2015-03-29 11:25:00 -0500
committerMichael Steinert <[email protected]>2015-03-29 11:25:00 -0500
commit9c771166c9fb45cfa72779c356962f51022a6903 (patch)
tree5e71a54944eb9fbee940db70bc1c38d457a37d55 /README.md
parentb380319c58ed6bf1023f8e58f78f593fa28c234b (diff)
Add a test suite
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index d41a5fd..577ac24 100644
--- a/README.md
+++ b/README.md
@@ -11,5 +11,15 @@ There's an example of a "fake login" program in the examples directory.
Look at the pam module's [godocs][1] for details about the Go API, or refer
to the official [PAM documentation][2].
+The test suite must be run as the root user. To setup your system for testing,
+create a user named "test" with the password "secret". For example:
+
+```
+$ sudo useradd test \
+ -d /tmp/test \
+ -p '$1$Qd8H95T5$RYSZQeoFbEB.gS19zS99A0' \
+ -s /bin/false
+```
+
[1]: http://godoc.org/github.com/msteinert/pam
[2]: http://www.kernel.org/pub/linux/libs/pam/Linux-PAM-html/adg-interface-by-app-expected.html