From d297110d889bd4cbbf03738ae81e35f380bf5022 Mon Sep 17 00:00:00 2001 From: Nick Pegg Date: Sun, 11 Aug 2024 17:32:02 -0700 Subject: [PATCH] Add installation instructions to README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9fbd5a..fd7d2a1 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,16 @@ It's everything I need and nothing I don't. ## Getting Started -TODO: Installation instructions lol +### Installation + +Photojawn requires at least Python 3.12. If you don't know what version you +have, you can check by running `python -V`. + +1. Head on over to the [releases](https://github.com/nickpegg/photojawn/releases) page +2. If you have Python >=3.12, you can install using the wheel (`.whl` file) + a. To install, run `pip install photojawn--py3-none-any.whl` +3. If you don't have Python >=3.12, you can download one of the standalone binaries depending on your OS and architecture, e.g. `photojawn-linux-x86_64`. + ### Initialization