diff --git a/README.md b/README.md new file mode 100644 index 0000000..090b9ba --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# pw - Password generator + +## Quick start + +### Build + +`make` + +### Install + +`sudo make install` + +(or, on OpenBSD): + +`doas gmake install` + +### Usage + +`pw` + +Generate password using default settings. + +## Documentation + +See the man page, when installed: + +`man pw` + +## Dependencies + +First build & install +[libscnumerics](https://git.bobpolis.com/bob/libscnumerics). +