From 1b4109b0d00236763acd55435ed21b569f555546 Mon Sep 17 00:00:00 2001 From: Hugohong258 Date: Tue, 15 Sep 2026 17:13:25 +0800 Subject: [PATCH] docs: clarify that prebuilt downloads are standalone executables (#3632) State explicitly in the README and download page that the platform-specific prebuilt files are standalone executables, not archives. Include the rename and executable-permission step for macOS and Linux in the README. Addresses #2956. Source archives are not described as executables. Validation: the official `docs/build_website.py` completed and the generated download page contains the new guidance. Used a Python venv with the site's required rendering packages; restored the Windows checkout's manual symlink in a temporary build copy only. jq itself was not built or tested for this documentation-only change. Co-authored-by: Hugohong258 <282228220+Hugohong258@users.noreply.github.com> --- README.md | 2 ++ docs/content/download/default.yml | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9ef09cc4..bb4a9dd9 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ ### Prebuilt Binaries Download the latest releases from the [GitHub release page](https://github.com/jqlang/jq/releases). +The platform-specific assets are standalone executables, not archives. On macOS and Linux, +rename the downloaded file to `jq` and make it executable with `chmod +x jq`. ### Docker Image diff --git a/docs/content/download/default.yml b/docs/content/download/default.yml index 223f533a..06eaebde 100644 --- a/docs/content/download/default.yml +++ b/docs/content/download/default.yml @@ -3,8 +3,9 @@ body: - text: | jq is written in C and has no runtime dependencies, so it should be - possible to build it for nearly any platform. Prebuilt binaries are - available for Linux, macOS and Windows. + possible to build it for nearly any platform. The prebuilt files linked + below are standalone executables, not archives, and are available for + Linux, macOS and Windows. The binaries should just run, but on macOS and Linux you may need to make them executable first using `chmod +x jq`.