From 1db374bf2413300d19f0cef10320d6a0eaa4982b Mon Sep 17 00:00:00 2001 From: Dana Whitfield Date: Fri, 20 Mar 2026 10:12:00 +0100 Subject: [PATCH] docs: add an installation guide --- README.md | 9 +++++++++ docs/install.md | 23 +++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/install.md diff --git a/README.md b/README.md index 7e74e12da14a8720a603fec2e6e0e5f5a8ba29cb..e2728d88227f7109a20c396b0d52db463fac8626 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000000000000000000000000000000000000..0063cde5b106a1aba4268437a21e68e187b85eaf --- /dev/null +++ b/docs/install.md @@ -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 +```