M README.md => README.md +9 -0
@@ 3,6 3,15 @@
**hello-hut** is a small, friendly greeting tool for your terminal. It says
hello — and that is all it does.
+## Installation
+
+```sh
+pip install hello-hut
+```
+
+See [docs/install.md](docs/install.md) for other ways to install it,
+including running straight from a checkout.
+
## Usage
```console
A docs/install.md => docs/install.md +23 -0
@@ 0,0 1,23 @@
+# Installing hello-hut
+
+hello-hut needs Python 3.9 or newer and has no other dependencies.
+
+## From PyPI
+
+```sh
+pip install --user hello-hut
+```
+
+## From a checkout
+
+```sh
+git clone https://git.hut.md/~reviewer/hello-hut
+cd hello-hut
+pip install --user .
+```
+
+To try it without installing anything:
+
+```sh
+PYTHONPATH=src python3 -m hello_hut Ada
+```