docs: show the menu as real screenshots

This commit is contained in:
Felitendo committed 2026-09-24 02:00:35 +02:00
1 parent b4038baf5b
commit 1f0fb22d1c
4 files changed
+10 -30

No files matched your search

+3 -10
View File
@@ -125,16 +125,9 @@ _2026-08-08_
Welcome to the very first release of cachy-auto-update! It keeps CachyOS up to date on its own: pacman, AUR, Flatpak and AppImages, installed in the background with no password prompt and nothing for you to do.
```
CachyOS Auto-Update
Automatic updates ON
Notifications ON
Last check 3 hours ago
Last successful update Sat 08 Aug 2026 04:12:03 CEST (23 packages)
Next scheduled run Sat 08 Aug 2026 05:00:00 CEST
```
<p align="center">
<img width="620" alt="The cachy-auto-update menu in Konsole" src="https://raw.githubusercontent.com/LoonixTools/cachy-auto-update/a56e804c41923d7531d578728f43d152ec275caa/res/screenshots/menu.png">
</p>
### Highlights
+4 -2
View File
@@ -55,8 +55,10 @@ Welcome to cachy-auto-update `v1.4.0`! One or two sentences on what this release
- Second highlight
```
A picture or a snippet of the menu under the welcome is optional. The highlights stay a plain list:
no heading or text per highlight, the list of commits explains the rest.
A picture under the welcome is optional. To show the menu or another screen of the program, use a
real screenshot of it running in Konsole, in English. Never a text copy of the screen. The same goes
for the README. The highlights stay a plain list: no heading or text per highlight, the list of
commits explains the rest.
A patch release is just a sentence or two, for example: "A small patch. The menu no longer closes
when you press Enter." The list of commits follows on its own.
+3 -18
View File
@@ -40,24 +40,9 @@ Updates are **off** until you enable them.
sudo cachy-auto-update
```
```
CachyOS Auto-Update
Automatic updates ON
Notifications ON
Last check 3 hours ago
Last successful update Sat 08 Aug 2026 04:12:03 CEST (23 packages)
Next scheduled run Sat 08 Aug 2026 05:00:00 CEST
[1] Toggle automatic updates
[2] Toggle notifications
[3] Update now
[4] Show log
[5] Show current conditions
[6] Settings
[q] Quit
```
<p align="center">
<img src="res/screenshots/menu.png" alt="The cachy-auto-update menu in Konsole: automatic updates and notifications on" width="620">
</p>
Everything is configurable from **[6] Settings**.
The interface is also translated to German (more langs coming soon (maybe)).
Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB