From 22605d8f8e1d7d54ae6fbd25e87634dbf6297838 Mon Sep 17 00:00:00 2001 From: ruiny Date: Sun, 31 May 2026 05:58:54 +0530 Subject: [PATCH] docs: better readme --- README.md | 42 +----------------------------------------- 1 file changed, 1 insertion(+), 41 deletions(-) diff --git a/README.md b/README.md index 1991899..54aea2f 100644 --- a/README.md +++ b/README.md @@ -6,47 +6,7 @@ Just a QML-only cat clock widget for KDE Plasma 6. Bootstrapped from my [kde-6-w ![Screenshot from desktop](Example.png) -# Install +## Install - clone the repo - `make install` from repo root - -# Package - -- `make package` builds a `.plasmoid` archive from the QML package and bundled image assets - -# Pling Upload - -This repo includes the same OpenDesktop/Pling uploader flow used by -`kde-6-widget-starter`. - -Dry run validates login, project edit-page access, and upload endpoint discovery: - -```bash -uv run python scripts/pling_upload.py --dry-run -``` - -Live mode uploads the packaged plasmoid and replaces the current files on the -target Pling project: - -```bash -uv run python scripts/pling_upload.py -f build/katoclock.ruiny.de.plasmoid -``` - -The uploader reads the same environment variables as the starter: -`PLING_PROJECT_ID`, `PLING_USERNAME`, `PLING_PASSWORD`, `PLING_FILES`, -`PLING_TIMEOUT`, and `PLING_MAX_RETRIES`. - -# GitHub Actions Release Upload - -The workflow lives at `.github/workflows/pling-release-upload.yml`. - -- Trigger: push a git tag matching `release*`, for example `release-v1.0.1` -- Build artifact: `build/katoclock.ruiny.de.plasmoid` -- Upload target: the Pling project identified by `PLING_PROJECT_ID` - -Required GitHub repository secrets: - -- `PLING_PROJECT_ID` -- `PLING_USERNAME` -- `PLING_PASSWORD`