Skip to content

Commit 9ea4371

Browse files
ShadowfetchShadowfetch
authored andcommitted
Docs: 2.2.0 is the published release; mark Windows as not released yet; fix xAI CLI link; add support link
1 parent 653daf8 commit 9ea4371

4 files changed

Lines changed: 29 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ The code is open source; the Shadowfetch and ShadowCode product identity is cove
7272
own terminal, go from commit to pull request, preview the app you're
7373
building, dictate with your voice, and follow along from your phone.
7474

75-
ShadowCode **2.3.0** is available in [GitHub releases](https://github.com/ShadowfetchStudio/ShadowCode/releases/tag/v2.3.0) for x86_64 and 64-bit ARM Linux, from the signed APT repository below, for macOS (Apple silicon and Intel) and, for the first time, for Windows.
76-
See the [2.3.0 release notes](docs/RELEASE_NOTES.md) for changes and qualification
77-
limits, and the [release history](CHANGELOG.md).
75+
ShadowCode **2.2.0** is the current release, available in [GitHub releases](https://github.com/ShadowfetchStudio/ShadowCode/releases/tag/v2.2.0) for x86_64 and 64-bit ARM Linux, from the signed APT repository below and for macOS (Apple silicon and Intel).
76+
See the [2.2.0 release notes](https://github.com/ShadowfetchStudio/ShadowCode/releases/tag/v2.2.0) for changes and qualification
77+
limits, and the [release history](CHANGELOG.md). Windows is in development
78+
for the next release and is not released yet (see [Windows](#windows)).
7879

7980
## Install
8081

@@ -91,13 +92,12 @@ file name. See
9192
From 2.2.0 each release also carries Flatpak bundles for both architectures
9293
(`ShadowCode_VERSION_x86_64.flatpak`, `ShadowCode_VERSION_aarch64.flatpak`,
9394
checked with `ShadowCode_VERSION_flatpak.sha256`; see [Flatpak](docs/FLATPAK.md))
94-
and macOS disk images (see [macOS](#macos)); from 2.3.0 a Windows installer
95-
too (see [Windows](#windows)).
95+
and macOS disk images (see [macOS](#macos)).
9696
Check [GitHub releases](https://github.com/ShadowfetchStudio/ShadowCode/releases)
97-
for published versions. The 2.3.0 x86_64 packages and checksums are:
97+
for published versions. The 2.2.0 x86_64 packages and checksums are:
9898

99-
- `ShadowCode_2.3.0_amd64.AppImage`
100-
- `ShadowCode_2.3.0_amd64.deb`
99+
- `ShadowCode_2.2.0_amd64.AppImage`
100+
- `ShadowCode_2.2.0_amd64.deb`
101101
- `SHA256SUMS`, `RELEASE-MANIFEST.json`, `RELEASE-AUTH` and
102102
`RELEASE-AUTH.sig` (download these beside the package; the installer checks
103103
the publisher's signature before running anything)
@@ -131,7 +131,11 @@ cmake.
131131

132132
### Windows
133133

134-
From 2.3.0, releases also carry `ShadowCode_VERSION_x64-setup.exe` for
134+
> **Not released yet.** Windows support is in development for the next
135+
> release (2.3.0). No published release includes a Windows installer yet, so
136+
> the steps below do not work today; they describe the planned installer.
137+
138+
From 2.3.0, releases are planned to also carry `ShadowCode_VERSION_x64-setup.exe` for
135139
64-bit Windows 10 (version 1809 or later) and 11, with its SHA-256 checksum in
136140
`ShadowCode_VERSION_windows.sha256`. It installs for your user only (no
137141
administrator rights) and includes llama.cpp for local models (CPU) and the
@@ -182,7 +186,7 @@ bundle and bootstrap requirements.
182186
From that independently authenticated installer bundle, run:
183187

184188
```bash
185-
bash /path/to/trusted-bundle/scripts/install-appimage.sh /path/to/downloads/ShadowCode_2.3.0_amd64.AppImage
189+
bash /path/to/trusted-bundle/scripts/install-appimage.sh /path/to/downloads/ShadowCode_2.2.0_amd64.AppImage
186190
```
187191

188192
The installer takes the AppImage path (or `--recover`), resolves its own trusted
@@ -228,7 +232,7 @@ as `--trust-dir` are not installer options.
228232
cannot corrupt it.
229233

230234
After obtaining and verifying the intended package, run the AppImage without installing it:
231-
`./ShadowCode_2.3.0_amd64.AppImage --appimage-extract-and-run`. FUSE is not
235+
`./ShadowCode_2.2.0_amd64.AppImage --appimage-extract-and-run`. FUSE is not
232236
required.
233237

234238
### Debian package
@@ -276,16 +280,16 @@ installed. The repository is published by the release workflow only; nothing
276280
in ShadowCode adds or contacts it by itself.
277281

278282
To install one release by hand instead, verify the Debian artifact using the independently trusted verifier bundle.
279-
`verified-deb-2.3.0` must not already exist; install the verified snapshot:
283+
`verified-deb-2.2.0` must not already exist; install the verified snapshot:
280284

281285
```bash
282286
bash /path/to/trusted-bundle/scripts/verify-native-release.sh \
283287
--bundle-dir /path/to/downloads \
284288
--trust-dir /path/to/trusted-bundle/release/trust \
285-
--artifact ShadowCode_2.3.0_amd64.deb \
286-
--stage-dir ./verified-deb-2.3.0 \
287-
--expect-version 2.3.0
288-
sudo apt install ./verified-deb-2.3.0/ShadowCode_2.3.0_amd64.deb
289+
--artifact ShadowCode_2.2.0_amd64.deb \
290+
--stage-dir ./verified-deb-2.2.0 \
291+
--expect-version 2.2.0
292+
sudo apt install ./verified-deb-2.2.0/ShadowCode_2.2.0_amd64.deb
289293
```
290294

291295
A `.deb` installed by hand this way gets no updates and none of the APT
@@ -871,6 +875,10 @@ xvfb-run -a dbus-run-session -- node scripts/test-native-first-run.mjs
871875
- Package notices: [licenses/native](licenses/native/README.md). Packaging
872876
for distributions: [Distributing ShadowCode](docs/DISTRIBUTING.md).
873877

878+
## Support the project
879+
880+
If ShadowCode is useful to you, you can [buy me a coffee](https://www.buymeacoffee.com/shadowfetcu).
881+
874882
## License
875883

876884
ShadowCode is licensed under the [Apache License 2.0](LICENSE) · Copyright

‎docs/DISTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The Flatpak bundles are attached after publication by
4949
`.github/workflows/release-flatpak.yml` (from 2.2.0), with SHA-256 checksums
5050
in `ShadowCode_VERSION_flatpak.sha256` rather than publisher signatures; the
5151
macOS disk images likewise (`release-macos.yml`, `ShadowCode_VERSION_macos.sha256`),
52-
and from 2.3.0 the Windows installer with the complete source of its bundled
52+
and, once 2.3.0 is published (Windows is not released yet), the Windows installer with the complete source of its bundled
5353
busybox-w32 (`release-windows.yml`, `ShadowCode_VERSION_windows.sha256`).
5454

5555
Releases before 2.1.0 have no aarch64 packages; build them from source (below)

‎docs/FLATPAK.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ Download the bundle for your computer and the checksum file from the
1616
release, then:
1717

1818
```sh
19-
sha256sum --check --ignore-missing ShadowCode_2.3.0_flatpak.sha256
20-
flatpak install --user ./ShadowCode_2.3.0_x86_64.flatpak
19+
sha256sum --check --ignore-missing ShadowCode_2.2.0_flatpak.sha256
20+
flatpak install --user ./ShadowCode_2.2.0_x86_64.flatpak
2121
flatpak run com.shadowfetch.shadowcode
2222
```
2323

24-
On 64-bit ARM, install `ShadowCode_2.3.0_aarch64.flatpak` instead.
24+
On 64-bit ARM, install `ShadowCode_2.2.0_aarch64.flatpak` instead.
2525

2626
The bundle points to Flathub for the GNOME runtime. Installation exports the
2727
application launcher and icons into the desktop's Applications menu.

‎docs/SUBSCRIPTIONS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ server is installed from **Settings › Accounts** (see
2020
| Claude Code | `claude` | [Claude Code](https://code.claude.com/docs/en/headless) | **Connect** runs `claude auth login` |
2121
| Cursor | `cursor-agent` | [Cursor CLI](https://cursor.com/docs/cli/acp) | **Connect** runs `cursor-agent login` |
2222
| Antigravity | `agy_acp_server.par` (Google's ACP agent server) | **Install** in **Settings › Accounts** downloads Google's official agent server (334 MB from dl.google.com, checked against a pinned SHA-256) | **Connect** signs in with Google in the browser |
23-
| Grok | `grok` | [xAI CLI](https://docs.x.ai/build) | **Connect** runs `grok login` |
23+
| Grok | `grok` | [xAI CLI](https://docs.x.ai/build/cli/reference) | **Connect** runs `grok login` |
2424

2525
- **Connect** runs the login command with your environment, minus provider API
2626
keys. The vendor opens your browser or prints a URL or device code, and

0 commit comments

Comments
 (0)