From de6b6e20a56a0f3da18e13de8cfa0cd166fe476a Mon Sep 17 00:00:00 2001 From: vikingowl Date: Sat, 18 Oct 2025 03:25:10 +0200 Subject: [PATCH] docs(readme): quick start matrices + platform notes --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 325eba0..1a4e66c 100644 --- a/README.md +++ b/README.md @@ -57,20 +57,28 @@ Owlen is designed to keep data local by default while still allowing controlled ### Installation -#### Linux & macOS -The recommended way to install on Linux and macOS is to clone the repository and install using `cargo`. +Pick the option that matches your platform and appetite for source builds: + +| Platform | Package / Command | Notes | +| --- | --- | --- | +| Arch Linux | `yay -S owlen-git` | Builds from the latest `dev` branch via AUR. | +| Other Linux | `cargo install --path crates/owlen-cli --locked --force` | Requires Rust 1.75+ and a running Ollama daemon. | +| macOS | `cargo install --path crates/owlen-cli --locked --force` | macOS 12+ tested. Install Ollama separately (`brew install ollama`). The binary links against the system OpenSSL – ensure Command Line Tools are installed. | +| Windows (experimental) | `cargo install --path crates/owlen-cli --locked --force` | Enable the GNU toolchain (`rustup target add x86_64-pc-windows-gnu`) and install Ollama for Windows preview builds. Some optional tools (e.g., Docker-based code execution) are currently disabled. | + +If you prefer containerised builds, use the provided `Dockerfile` as a base image and copy out `target/release/owlen`. + +Run the helper scripts to sanity-check platform coverage: ```bash -git clone https://github.com/Owlibou/owlen.git -cd owlen -cargo install --path crates/owlen-cli +# Windows compatibility smoke test (GNU toolchain) +scripts/check-windows.sh + +# Reproduce CI packaging locally (choose a target from .woodpecker.yml) +dev/local_build.sh x86_64-unknown-linux-gnu ``` -**Note for macOS**: While this method works, official binary releases for macOS are planned for the future. -#### Windows -The Windows build has not been thoroughly tested yet. Installation is possible via the same `cargo install` method, but it is considered experimental at this time. - -From Unix hosts you can run `scripts/check-windows.sh` to ensure the code base still compiles for Windows (`rustup` will install the required target automatically). +> **Tip (macOS):** On the first launch macOS Gatekeeper may quarantine the binary. Clear the attribute (`xattr -d com.apple.quarantine $(which owlen)`) or build from source locally to avoid notarisation prompts. ### Running OWLEN