From 995564894921376b9f25a9f1da66c860629cee3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Backstr=C3=B6m?= Date: Fri, 6 Sep 2024 18:49:55 +0200 Subject: [PATCH] Update readme with install instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 5c959e2..85eed76 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # brkn-lnk brkn-lnk (broken link) is a link checker +# Install +>[!NOTE] +> Binaries are only provided for Windows. +> +> The software has only been tested on Windows 11 but may work on other platforms if built from source. +1. Download latest release from the [releases page](https://github.com/Mozzo1000/brkn-lnk/releases) +2. Save the .exe file in a folder of your choosing. +3. Edit your PATH environment variable to point to the folder that contains the .exe file. + 1. See https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/ for how to edit PATH. # Usage ## Check single url