Skip to content

Commit b9ebc2d

Browse files
authored
Merge pull request #338 from matveynator/tvey/update-readme.md-for-stable-release
docs: align central README downloads with Stable Release flow
2 parents 6679973 + cc7f988 commit b9ebc2d

1 file changed

Lines changed: 76 additions & 63 deletions

File tree

README.md

Lines changed: 76 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -16,90 +16,82 @@ Radiacode, AtomFast, BGeigie Safecast devices supported.
1616
</div>
1717

1818

19-
## Desktop app (GUI)
20-
21-
Best for personal local use.
22-
23-
### Download
24-
- [Desktop for Windows (amd64)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_amd64_desktop.exe)
25-
- [Desktop for Windows (arm64)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_arm64_desktop.exe)
26-
- [Desktop for Windows (amd64, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_amd64_desktop.zip)
27-
- [Desktop for Windows (arm64, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_arm64_desktop.zip)
28-
- [Desktop for macOS Apple Silicon (arm64)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_arm64_desktop)
29-
- [Desktop for macOS Intel (amd64)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_amd64_desktop)
30-
- [Desktop for Linux (amd64, Mint 21 / Ubuntu 22.04, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64_desktop_gtk40.zip)
31-
- [Desktop for Linux (amd64, Mint 22 / Ubuntu 24.04+, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64_desktop_gtk41.zip)
32-
- [Desktop for Linux (arm64, Mint 21 / Ubuntu 22.04, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_arm64_desktop_gtk40.zip)
33-
- [Desktop for Linux (arm64, Mint 22 / Ubuntu 24.04+, zip)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_arm64_desktop_gtk41.zip)
34-
35-
### Run
19+
## Downloads (Stable Release)
20+
21+
Use the **Stable Release** channel so one constant link always points to the newest binaries built from commits containing `stable release`.
22+
23+
- **Smart download page (recommended):** https://matveynator.github.io/chicha-isotope-map/
24+
- **Stable Release tag (all artifacts):** https://github.com/matveynator/chicha-isotope-map/releases/tag/stable-release
25+
26+
### Desktop app (GUI)
27+
28+
Pick your OS first, then architecture.
29+
30+
| OS | Architecture / Variant | Artifact |
31+
|---|---|---|
32+
| macOS | Universal (Intel + Apple Silicon) | [chicha-isotope-map_darwin_universal_desktop.dmg](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_universal_desktop.dmg) |
33+
| Windows | amd64 | [chicha-isotope-map_windows_amd64_desktop.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_amd64_desktop.zip) |
34+
| Windows | arm64 | [chicha-isotope-map_windows_arm64_desktop.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_arm64_desktop.zip) |
35+
| Linux GTK 4.0 (Ubuntu 22.04 / Mint 21.x) | amd64 | [chicha-isotope-map_linux_amd64_desktop_gtk40.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64_desktop_gtk40.zip) |
36+
| Linux GTK 4.0 (Ubuntu 22.04 / Mint 21.x) | arm64 | [chicha-isotope-map_linux_arm64_desktop_gtk40.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_arm64_desktop_gtk40.zip) |
37+
| Linux GTK 4.1 (Ubuntu 24.04+ / Mint 22+) | amd64 | [chicha-isotope-map_linux_amd64_desktop_gtk41.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64_desktop_gtk41.zip) |
38+
| Linux GTK 4.1 (Ubuntu 24.04+ / Mint 22+) | arm64 | [chicha-isotope-map_linux_arm64_desktop_gtk41.zip](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_arm64_desktop_gtk41.zip) |
39+
40+
### Server binaries (self-hosted)
41+
42+
| OS | Architecture | Artifact |
43+
|---|---|---|
44+
| Linux | amd64 | [chicha-isotope-map_linux_amd64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64) |
45+
| Linux | arm64 | [chicha-isotope-map_linux_arm64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_arm64) |
46+
| Windows | amd64 | [chicha-isotope-map_windows_amd64.exe](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_amd64.exe) |
47+
| Windows | arm64 | [chicha-isotope-map_windows_arm64.exe](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_arm64.exe) |
48+
| macOS | amd64 | [chicha-isotope-map_darwin_amd64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_amd64) |
49+
| macOS | arm64 | [chicha-isotope-map_darwin_arm64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_arm64) |
50+
| FreeBSD | amd64 / arm64 | [Stable Release assets](https://github.com/matveynator/chicha-isotope-map/releases/tag/stable-release) |
51+
| OpenBSD | amd64 / arm64 | [Stable Release assets](https://github.com/matveynator/chicha-isotope-map/releases/tag/stable-release) |
52+
53+
### Quick run
54+
3655
Windows:
37-
1. Download `.exe` directly (or `.zip` if your browser/security policy blocks direct `.exe` downloads)
38-
2. Double click
39-
3. If SmartScreen appears: **More info → Run anyway**
56+
1. Download a `.zip` desktop build (or `.exe` server build).
57+
2. Extract if needed.
58+
3. Run the binary. If SmartScreen appears: **More info → Run anyway**.
4059

41-
macOS:
60+
macOS (server binary example):
4261
```bash
43-
chmod +x ./chicha-isotope-map_darwin_*_desktop
44-
./chicha-isotope-map_darwin_*_desktop
62+
chmod +x ./chicha-isotope-map_darwin_*
63+
./chicha-isotope-map_darwin_*
4564
```
4665

47-
Linux:
66+
Linux desktop (GTK 4.1 amd64 example):
4867
```bash
4968
curl -fL https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64_desktop_gtk41.zip -o chicha-isotope-map-desktop.zip
5069
unzip chicha-isotope-map-desktop.zip
5170
chmod +x ./chicha-isotope-map_linux_amd64_desktop_gtk41
5271
./chicha-isotope-map_linux_amd64_desktop_gtk41
5372
```
54-
Linux desktop release now ships as a regular executable binary in a `.zip` archive.
55-
Use `*_gtk40` for Ubuntu 22.04 / Mint 21 and `*_gtk41` for Ubuntu 24.04+ / Mint 22 (both amd64 and arm64).
56-
57-
### Build desktop from source
58-
59-
Desktop WebView builds require CGO.
60-
61-
macOS/Linux:
62-
```bash
63-
CGO_ENABLED=1 go build -tags desktop .
64-
./chicha-isotope-map -desktop
65-
```
6673

67-
Server-only binary (no embedded desktop window):
74+
Linux server quick install:
6875
```bash
69-
CGO_ENABLED=0 go build .
70-
./chicha-isotope-map
76+
sudo curl -fL https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64 -o /usr/local/bin/chicha-isotope-map
77+
sudo chmod +x /usr/local/bin/chicha-isotope-map
78+
/usr/local/bin/chicha-isotope-map
7179
```
72-
73-
### Screenshots:
74-
75-
<img width="100%" alt="desktop placeholder 1" src="https://github.com/user-attachments/assets/617a0ced-4280-41c2-9320-de1cfd33a61f" />
76-
<img width="100%" alt="desktop placeholder 2" src="https://github.com/user-attachments/assets/13256b23-744d-4d02-a26c-ae9aef5b0d87" />
80+
Open: http://localhost:8765
7781

7882
---
7983

80-
## Server version (self-hosted)
81-
82-
### Quick start (Linux)
83-
```bash
84-
sudo curl -fL https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_linux_amd64 -o /usr/local/bin/chicha-isotope-map; chmod +x /usr/local/bin/chicha-isotope-map; /usr/local/bin/chicha-isotope-map;
85-
```
86-
Open: [http://localhost:8765](http://localhost:8765)
84+
## Program screenshots
8785

88-
### Other server binaries
89-
- [Server for Windows (amd64)](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_windows_amd64.exe)
90-
- [Server for macOS arm64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_arm64)
91-
- [Server for macOS amd64](https://github.com/matveynator/chicha-isotope-map/releases/download/stable-release/chicha-isotope-map_darwin_amd64)
92-
- [All release assets (FreeBSD/OpenBSD/arm64/etc)](https://github.com/matveynator/chicha-isotope-map/releases/tag/stable-release)
86+
Screenshots are taken from the official stable download page:
9387

94-
### Public HTTPS domain
95-
```bash
96-
./chicha-isotope-map -domain your-domain.example
97-
```
98-
Ports 80/443 must be open.
88+
![macOS desktop preview](https://matveynator.github.io/chicha-isotope-map/chicha-isotope-map-macosx-universal.png)
89+
![Windows desktop preview](https://matveynator.github.io/chicha-isotope-map/windows-osm-light.png)
90+
![Linux desktop preview](https://matveynator.github.io/chicha-isotope-map/linux-amd64-desktop.png)
9991

10092
---
10193

102-
## Advanced flags and PostgreSQL
94+
## Configuration and deployment
10395

10496
### Useful flags
10597
- `-port 8765`
@@ -123,12 +115,33 @@ Ports 80/443 must be open.
123115
-port 8765
124116
```
125117

118+
### Public HTTPS domain
119+
```bash
120+
./chicha-isotope-map -domain your-domain.example
121+
```
122+
Ports `80/443` must be open.
123+
126124
### Preload real tracks once
127125
```bash
128126
./chicha-isotope-map -import-tgz-url https://pelora.org/api/json/weekly.tgz
129127
```
130128

129+
### Build from source
130+
131+
Desktop WebView builds require CGO.
132+
133+
```bash
134+
CGO_ENABLED=1 go build -tags desktop .
135+
./chicha-isotope-map -desktop
136+
```
137+
138+
Server-only binary (no embedded desktop window):
139+
```bash
140+
CGO_ENABLED=0 go build .
141+
./chicha-isotope-map
142+
```
131143

144+
---
132145

133146
## Universal isotope catalog and spectrum drivers
134147

@@ -154,7 +167,7 @@ This gives one universal parser entrypoint and one extensible isotope catalog, w
154167

155168
---
156169

157-
## History and contributors
170+
## Acknowledgements
158171

159172
This project was conceived to grant people a clear and immediate understanding of radiation safety in the very places they inhabit—where they reside, labor, cultivate the land, and draw water.
160173

0 commit comments

Comments
 (0)