From 6eb27b7cd6dea5866fc4523507df9e6e951f9bd9 Mon Sep 17 00:00:00 2001 From: Olivier Date: Thu, 24 Sep 2026 17:25:57 -0400 Subject: [PATCH] docs: document Linux build and prebuilt binary installation --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 02b613d..309b016 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,30 @@ A Python-based command-line interface for interacting with Obsidian vaults. Manage notes directly from the terminal without opening Obsidian. -## Building the Windows Executable (.exe) +## Building a Standalone Executable -You can build a standalone Windows executable using PyInstaller: +The same `onyx.spec` builds on both Windows and Linux — PyInstaller doesn't +cross-compile, so build natively on each platform: ```bash pip install pyinstaller python -m PyInstaller onyx.spec ``` -The resulting `onyx.exe` will be found in the `dist` folder. +- Windows produces `dist/onyx.exe` +- Linux produces `dist/onyx` (no extension) + +Prebuilt binaries for both platforms are also attached to each release: +https://gitea.mithrilforge.dev/olivier/onyx-cli/releases + +### Installing the Linux binary + +Drop the binary (built or downloaded) anywhere on your `PATH`: + +```bash +chmod +x onyx +mv onyx ~/.local/bin/onyx # or /usr/local/bin/onyx (needs sudo) +``` ## Installation