Add direct links to binaries.

kdeldycke · Feb 15, 2023 · 5b40d04 · 5b40d04
1 parent a04494e
commit 5b40d04
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 10 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -1,5 +1,7 @@
 # Installation
 
+## From packages
+
 `````{tab-set}
 
 ````{tab-item} pipx
@@ -41,6 +43,48 @@ If you have difficulties to use `pip`, see
 ````
 `````
 
+## Binaries
+
+Binaries are compiled at each release, so you can skip the installation process above and download the standalone executables directly.
+
+This is the prefered way of testing `mdedup` without polluting your machine. They also offer the possibility of running the CLI on older systems not supporting the minimal Python version required by `mdedup`.
+
+| Platform    | `x86_64`                                                                                                                         |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| **Linux**   | [Download `mdedup-linux-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-linux-x64.bin)     |
+| **macOS**   | [Download `mdedup-macos-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-macos-x64.bin)     |
+| **Windows** | [Download `mdedup-windows-x64.exe`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-windows-x64.exe) |
+
+All links above points to the latest released version of `mdedup`.
+
+```{admonition} Older releases
+---
+class: seealso
+---
+If you need to test previous versions for regression, compatibility or general troubleshooting, you'll find the old binaries attached as assets to [past releases on GitHub](https://github.com/kdeldycke/mail-deduplicate/releases).
+```
+
+```{admonition} Development builds
+---
+class: caution
+---
+Each commit to the development branch triggers the compilation of binaries. This way you can easily test the bleeding edge version of `mdedup` and report any issue.
+
+Look at the [list of latest binary builds](https://github.com/kdeldycke/mail-deduplicate/actions/workflows/release.yaml?query=branch%3Amain+is%3Asuccess). Then select the latest `Build & release`/`release.yaml` workflow run and download the binary artifact corresponding to your platform and architecture.
+```
+
+````{admonition} ABI targets
+---
+class: seelalso
+---
+```{code-block} shell-session
+$ file ./mdedup*
+./mdedup-linux-x64.bin:   ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=d0a8ae1ffa469465a836c1505504d1b1c75725b0, for GNU/Linux 3.2.0, stripped
+./mdedup-macos-x64.bin:   Mach-O 64-bit executable x86_64
+./mdedup-windows-x64.exe: PE32+ executable (console) x86-64, for MS Windows
+```
+````
+
 ## Run `mdedup`
 
 Mail Deduplicate should now be available system-wide:

diff --git a/readme.md b/readme.md
@@ -32,7 +32,7 @@ Provides the `mdedup` CLI, an utility to deduplicate mails from a set of boxes.
 - Dry-run mode.
 - Protection against false-positives with safety checks on size and content differences.
 - Supports macOS, Linux and Windows.
-- Standalone `x86_64` executables: [`mdedup.exe` for Windows](https://github.com/kdeldycke/mail-deduplicate/releases/latest), `mdedup.bin` [for Linux](https://github.com/kdeldycke/mail-deduplicate/releases/latest) and [for macOS](https://github.com/kdeldycke/mail-deduplicate/releases/latest).
+- [Standalone executables](#executables) for Linux, macOS and Windows.
 - Shell auto-completion for Bash, Zsh and Fish.
 
 > ⚠️ **Warning**: Performances
@@ -63,14 +63,12 @@ Other
 [alternatives installation methods](https://kdeldycke.github.io/mail-deduplicate/install.html)
 are available in the documentation.
 
-### Binaries
+### Executables
 
-Binaries are available so you can skip the installation process above and download the standalone executables directly:
+Standalone executables of `mdedup`'s latest version are available for several platforms and architectures:
 
-| Platform    | `x86_64`                                                                                                               |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------- |
-| **Linux**   | [Download `mdedup.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup_linux_x64.bin)   |
-| **macOS**   | [Download `mdedup.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup_macos_x64.bin)   |
-| **Windows** | [Download `mdedup.exe`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup_windows_x64.bin) |
-
-All links above points to the latest release version.
+| Platform    | `x86_64`                                                                                                             |
+| ----------- | -------------------------------------------------------------------------------------------------------------------- |
+| **Linux**   | [Download `mdedup-linux-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-linux-x64.bin)   |
+| **macOS**   | [Download `mdedup-macos-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-macos-x64.bin)   |
+| **Windows** | [Download `mdedup-windows-x64.exe`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-windows-x64.exe) |