-
Notifications
You must be signed in to change notification settings - Fork 46
docs: explain GitHub release asset naming in README #598
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -59,6 +59,26 @@ npx @kilocode/cli | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Then run `kilo` in any project directory to start. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Install from GitHub Releases (Optional) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If you prefer downloading a binary from the [Releases page](https://github.com/Kilo-Org/kilo/releases), use this quick guide: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `darwin` means macOS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `x64` is standard 64-bit Intel/AMD CPUs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `x64_baseline` is a compatibility build for older x64 CPUs that may not support newer instruction sets. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. WARNING: The build matrix does not include a Windows ARM64 target (
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `Source code` archives are for building from source, not normal installation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| For most users: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Windows (most PCs):** `kilo-windows-x64.zip` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Windows on ARM:** `kilo-windows-arm64.zip` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **macOS Intel:** `kilo-darwin-x64.zip` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Linux x64:** `kilo-linux-x64.zip` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
66
to
80
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | |
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. | |
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | |
| - `Source code` archives are for building from source, not normal installation. | |
| For most users: | |
| - **Windows (most PCs):** `kilo-windows-x64.zip` | |
| - **Windows on ARM:** `kilo-windows-arm64.zip` | |
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | |
| - **macOS Intel:** `kilo-darwin-x64.zip` | |
| - **Linux x64:** `kilo-linux-x64.zip` | |
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture on Windows and macOS. On Linux, binaries are published as `kilo-<os>-<arch>.tar.gz`. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | |
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux. | |
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | |
| - `Source code` archives are for building from source, not normal installation. | |
| For most users: | |
| - **Windows (most PCs):** `kilo-windows-x64.zip` | |
| - **Windows on ARM:** Native Windows ARM builds are not currently published. If supported by your system, you may run the x64 build under emulation. | |
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | |
| - **macOS Intel:** `kilo-darwin-x64.zip` | |
| - **Linux x64:** `kilo-linux-x64.tar.gz` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The release archives are not always
.zip. The build script produces.tar.gzarchives for Linux targets (and.zipfor non-Linux), so this line will mislead Linux users. Consider documenting the extension as platform-dependent (e.g.,.zipon macOS/Windows,.tar.gzon Linux).