Small documentation updates

This commit is contained in:
Michael Steinert
2015-03-30 19:16:13 -05:00
parent 8fad614175
commit 767cadc80c
2 changed files with 13 additions and 7 deletions

View File

@@ -11,8 +11,11 @@ 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:
## Testing
To run the full suite, the tests 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 \
@@ -21,5 +24,11 @@ $ sudo useradd test \
-s /bin/false
```
Then execute the tests:
```
$ sudo GOPATH=$GOPATH $(which go) test -v
```
[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