Skip to content

Commit b7d1bfc

Browse files
committed
Document GitHub release downloads
1 parent 599c7e5 commit b7d1bfc

2 files changed

Lines changed: 49 additions & 4 deletions

File tree

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
# ToastDesk
22

3-
ToastDesk is a Windows 11 desktop app that mirrors Windows notifications into persistent, always-on-top toast cards.
3+
Persistent Windows notifications you cannot miss.
44

5-
It is designed for people who miss important notifications because Windows Notification Center hides them behind the taskbar bell. ToastDesk keeps notifications visible until you take action.
5+
ToastDesk is a Windows 11 desktop app that mirrors Windows notifications into persistent, always-on-top toast cards. It keeps important alerts visible until you open or dismiss them.
66

77
![ToastDesk icon](assets/icons/ToastDesk.png)
88

9+
## Download
10+
11+
Download the latest Windows build from:
12+
13+
[ToastDesk Releases](https://github.com/nakorncode/toastdeck/releases/latest)
14+
15+
Use `ToastDesk-win-x64.zip`, extract it, then run `ToastDesk.exe`.
16+
17+
ToastDesk is currently distributed as a self-contained Windows x64 ZIP package. No separate .NET runtime install is required.
18+
919
## Status
1020

11-
ToastDesk is early public-preview software. Core notification capture, persistent overlay cards, tray behavior, settings, startup registration, and notification sounds are implemented. Installer/signing work is still in progress.
21+
ToastDesk is early public-preview software. Core notification capture, persistent overlay cards, tray behavior, settings, startup registration, notification actions, and notification sounds are implemented. Installer/signing work is still in progress.
1222

1323
## Features
1424

@@ -23,6 +33,25 @@ ToastDesk is early public-preview software. Core notification capture, persisten
2333
- Notification sound presets and custom sound files
2434
- Production-safe bundled sound assets
2535

36+
## Release Flow
37+
38+
Maintainers can publish a GitHub Release by pushing a version tag:
39+
40+
```powershell
41+
git tag v0.1.0
42+
git push origin v0.1.0
43+
```
44+
45+
The GitHub Actions release workflow will build `ToastDesk-win-x64.zip` and attach it to the release.
46+
47+
You can also create the package locally:
48+
49+
```powershell
50+
powershell -ExecutionPolicy Bypass -File .\scripts\publish-release.ps1
51+
```
52+
53+
The local package is written to `artifacts/release/ToastDesk-win-x64.zip`.
54+
2655
## Requirements
2756

2857
- Windows 11
@@ -41,7 +70,7 @@ powershell -ExecutionPolicy Bypass -File .\scripts\run-dev.ps1
4170
powershell -ExecutionPolicy Bypass -File .\scripts\run-build.ps1
4271
```
4372

44-
## Publish Release Package
73+
## Publish Release Package Locally
4574

4675
```powershell
4776
powershell -ExecutionPolicy Bypass -File .\scripts\publish-release.ps1

docs/release-template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# ToastDesk Release Template
2+
3+
## Download
4+
5+
Download `ToastDesk-win-x64.zip` from this release, extract it, then run `ToastDesk.exe`.
6+
7+
## Notes
8+
9+
- Windows 11 is the primary target.
10+
- The package is self-contained; no separate .NET runtime install is required.
11+
- Windows notification capture requires user permission.
12+
- This build is unsigned. Windows SmartScreen may warn on first launch until signing is added.
13+
14+
## Changes
15+
16+
-

0 commit comments

Comments
 (0)