admin/weather-and-stats
1
0
Fork 0
mirror of https://github.com/samjage/weather-and-stats.git synced 2026-06-06 00:20:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: polish README with tables and improved structure

Browse Source
This commit is contained in:
samjage
2026-03-29 11:44:25 -04:00
parent aae62f00f1
commit 3108ba3d84
1 changed files with 54 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+54 -26
View File
@@ -1,32 +1,39 @@
# Weather && Stats
A KDE Plasma 6 **panel/taskbar widget** that displays live weather and system stats in a single compact bar. Designed to sit in your top or bottom panel — not a desktop widget.
> A KDE Plasma 6 **panel/taskbar widget** displaying live weather and system stats in a single compact bar. Designed to sit in your top or bottom panel — not a desktop widget.
![Plasma 6](https://img.shields.io/badge/Plasma-6.0+-blue) ![License](https://img.shields.io/badge/License-GPL--2.0-green)
## Overview
![Plasma 6](https://img.shields.io/badge/Plasma-6.0+-blue) ![License](https://img.shields.io/badge/License-GPL--2.0-green) ![Version](https://img.shields.io/badge/Version-1.2-orange)
![Weather && Stats](weather-and-stats_example.png)
---
- **Weather** — current conditions via [Open-Meteo](https://open-meteo.com/) (no API key required)
- **CPU Temp** — reads directly from hwmon (Intel coretemp, AMD k10temp/zenpower, ARM cpu-thermal); turns red above your threshold
- **CPU Usage** — sampled from `/proc/stat`
- **Memory Usage** — percentage of RAM in use
- **Network Speed** — live download/upload on your most active interface
## Stats
All stats update on configurable intervals. Each section can be toggled on or off.
| Stat | Details |
|---|---|
| **Weather** | Current conditions via [Open-Meteo](https://open-meteo.com/) — no API key required |
| **CPU Temp** | Reads from hwmon (Intel coretemp, AMD k10temp/zenpower, ARM cpu-thermal); turns red above your threshold |
| **CPU Usage** | Sampled from `/proc/stat` |
| **Memory** | Percentage of RAM in use |
| **Network** | Live download/upload on your most active interface |
All stats refresh on configurable intervals. Each section can be toggled on or off.
---
## Requirements
- KDE Plasma 6.0+
- `bash`, `free`, `/proc/stat`, `/proc/net/dev` (standard on any Linux system)
- A [Nerd Font](https://www.nerdfonts.com/) set as your panel font is **optional** — the widget falls back to plain Unicode symbols if disabled in settings
| Requirement | Notes |
|---|---|
| KDE Plasma 6.0+ | |
| `bash`, `free`, `/proc/stat`, `/proc/net/dev` | Standard on any Linux system |
| [Nerd Font](https://www.nerdfonts.com/) | Optional — falls back to plain Unicode symbols if disabled in settings |
---
## Installation
### Manual
```bash
git clone https://github.com/samjage/weather-and-stats.git
kpackagetool6 --type Plasma/Applet --install weather-and-stats
@@ -36,34 +43,55 @@ Then right-click your panel → **Add Widgets** → search for **Weather && Stat
> **Placement:** Plasma always adds new widgets at a default position. After adding, right-click your panel → **Enter Edit Mode** and drag the widget to your preferred spot (e.g. left of the system tray). Plasma has no API for widgets to declare a position automatically.
### To update after changes
### Updating
```bash
kpackagetool6 --type Plasma/Applet --upgrade weather-and-stats
```
---
## Configuration
Right-click the widget → **Configure Weather && Stats**:
Right-click the widget → **Configure Weather && Stats**
### Weather
| Setting | Description | Default |
|---|---|---|
| Location | Search by city name (geocoded via Open-Meteo) | Chicago, IL |
| Location | City name, geocoded via Open-Meteo | Chicago, IL |
| Temperature unit | °F or °C | °F |
| Show condition text | Adds e.g. "Partly Cloudy" after the temp | Off |
| Weather refresh | How often to fetch weather (minutes) | 5 min |
| Weather refresh | How often to fetch weather | 5 min |
### System Stats
| Setting | Description | Default |
|---|---|---|
| CPU temp unit | °F or °C | °C |
| CPU temp alert threshold | Temp at which the reading turns red | 80°C |
| Stats refresh | How often to poll system stats (seconds) | 3 sec |
| Visible stats | Toggle CPU temp, CPU usage, memory, network | All on |
| Use Nerd Font icons | Use Nerd Font glyphs; disable for plain Unicode fallback | On |
| CPU temp threshold | Temp at which the reading turns red | 80°C |
| Stats refresh | How often to poll system stats | 3 sec |
| CPU temp | Toggle visibility | On |
| CPU usage | Toggle visibility | On |
| Memory | Toggle visibility | On |
| Network | Toggle visibility | On |
### Appearance
| Setting | Description | Default |
|---|---|---|
| Nerd Font icons | Disable for plain Unicode symbol fallback | On |
---
## How it works
Weather is fetched with a plain `XMLHttpRequest` — no API key, no account needed. Open-Meteo is free for non-commercial use.
Weather is fetched via `XMLHttpRequest` — no API key, no account needed. [Open-Meteo](https://open-meteo.com/) is free for non-commercial use.
System stats come from a small shell script (`contents/stats.sh`) that the widget runs on a timer. It takes two `/proc/stat` samples 1 second apart to calculate CPU usage, and reads the same interface from `/proc/net/dev` for network throughput. No external dependencies.
System stats come from `contents/stats.sh`, a small shell script the widget runs on a timer. It takes two `/proc/stat` samples 1 second apart to calculate CPU usage and reads `/proc/net/dev` for network throughput. No external dependencies beyond standard Linux interfaces.
---
## License
GPL-2.0 — see [LICENSE](LICENSE) if added, or the `metadata.json` for the declaration.
GPL-2.0 — see `metadata.json` for the declaration.