From cfd205ddff84f2b5fc562375195d37a87f24e84c Mon Sep 17 00:00:00 2001
From: Bob Polis <bob.polis@gmail.com>
Date: Tue, 26 Nov 2024 07:05:28 +0100
Subject: [PATCH] Add README

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

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