Skip to content

Commit 154e772

Browse files
committed
docs: add Start-Here tables to README.md, document llms.txt in CHANGELOG.md, and add llms.txt
1 parent 4c3e6bb commit 154e772

3 files changed

Lines changed: 82 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [Unreleased] - 2026-05-24
5+
## [Unreleased] - 2026-06-10
66

77
### Build / Release
88
- EXE neu gebaut 2026-06-01 (PyInstaller, `SoftwareCenter.spec`); 9/9 Tests grün, Smoke-Test bestanden. Vorherige EXE: 2026-05-01.
@@ -23,6 +23,7 @@ All notable changes to this project will be documented in this file.
2323
- GitHub Actions now install the app dependencies and run the PySide6 regression tests on Python 3.10, 3.11, and 3.12.
2424

2525
### Added
26+
- `llms.txt` in the repository root for LLM documentation visibility.
2627
- `scripts/run_windows_wack.py` for local Windows App Certification Kit dry-runs, real runs, and XML-to-JSON report summaries.
2728
- Regression tests for the WACK helper, covering MSIX/report path resolution and report parsing.
2829
- `tests/macos_platform_smoke.py` as a reproducible headless macOS source smoke for `.app` bundles and profile persistence.

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ Ein leichtgewichtiger, plattformübergreifender Desktop-Organizer für Software-
44

55
![SoftwareCenter Hauptfenster](README/screenshots/main.png)
66

7+
## Quick Start / Einstieg
8+
9+
| Eigenschaft | Details |
10+
|---|---|
11+
| **Tech Stack** | Python 3.10+ / PySide6 (Qt) / QSettings |
12+
| **Lizenz** | MIT (PySide6 dynamisch gelinkt unter LGPLv3) |
13+
| **Austauschformat** | `softwarecenter-profile-v1.json` (siehe [EXPORTFORMAT.md](EXPORTFORMAT.md)) |
14+
| **PWA-Begleiter** | Statischer Web/PWA-Companion (siehe [web_companion/README.md](web_companion/README.md)) |
15+
| **Letzte Prüfung** | 2026-06-10 (Hygiene- & LLM-Dokumentations-Check) |
16+
717
## Funktionen
818

919
- **Tab-Organisation** - Programme in benennbare, verschiebbare Tabs gruppieren
@@ -100,6 +110,16 @@ Unter [web_companion/README.md](web_companion/README.md) liegt jetzt ein statisc
100110

101111
A lightweight, cross-platform desktop organizer for managing software shortcuts with tab-based categorization.
102112

113+
### Quick Reference
114+
115+
| Attribute | Details |
116+
|---|---|
117+
| **Tech Stack** | Python 3.10+ / PySide6 (Qt) / QSettings |
118+
| **License** | MIT (PySide6 dynamically linked under LGPLv3) |
119+
| **Exchange Format** | `softwarecenter-profile-v1.json` (see [EXPORTFORMAT.md](EXPORTFORMAT.md)) |
120+
| **PWA Companion** | Static Web/PWA Companion (see [web_companion/README.md](web_companion/README.md)) |
121+
| **Last Checked** | 2026-06-10 (Hygiene & LLM Documentation Check) |
122+
103123
### Features
104124

105125
- **Tab Organization** - Group programs into renamable, movable tabs

llms.txt

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# SoftwareCenter
2+
3+
Canonical repository: https://github.com/file-bricks/SoftwareCenter
4+
Owner: file-bricks
5+
Primary language: Python
6+
Primary UI stack: PySide6
7+
License: MIT
8+
9+
Last-checked: 2026-06-10
10+
11+
## Search Phrases
12+
13+
- desktop organizer Python
14+
- PySide6 tab organizer
15+
- software shortcuts manager
16+
- application launcher Python
17+
- local-first software center
18+
- drag and drop app launcher
19+
- PySide6 desktop shortcut manager
20+
21+
## Audience
22+
23+
Power users and developers who want a local-first, lightweight desktop organizer for software shortcuts and files, along with offline browser-based companion viewing capabilities.
24+
25+
## Disambiguation
26+
27+
SoftwareCenter is a local desktop application (PySide6/Python) for shortcut management. It is not:
28+
- An app store or software package manager (it does not download or install packages)
29+
- A system-level shell replacement or taskbar manager
30+
- A cloud-synced launcher platform
31+
32+
## Summary
33+
34+
SoftwareCenter is a lightweight, cross-platform desktop organizer for software shortcuts. It organizes files and apps into renamable tabs using a clean PySide6 UI, saves view/tab states dynamically, and supports profile import/export (`softwarecenter-profile-v1.json`) with a static PWA companion.
35+
36+
## Current Scope
37+
38+
- Primary platform: Cross-platform desktop (Windows, macOS, Linux).
39+
- Build targets: PyInstaller standalone executables.
40+
- Companion scope: Static PWA (`web_companion/`) for offline viewing of exported profile JSONs.
41+
- Non-goals: Network package installation, automatic software updates, cloud-account synchronizations.
42+
43+
## Important Files
44+
45+
- `README.md`: English and German GitHub entry point.
46+
- `SoftwareCenter.py`: Main PySide6 application.
47+
- `EXPORTFORMAT.md`: Schema definition for versioned profile JSON.
48+
- `web_companion/`: HTML/JS static offline viewer.
49+
- `tests/`: Pytest suite (tests for platform/WACK compatibility and state persistence).
50+
51+
## Verification
52+
53+
Use these local checks before publishing changes:
54+
55+
```bash
56+
python -m pytest -q
57+
python -m compileall -q SoftwareCenter.py manage_translations.py translator.py
58+
```
59+
60+
The GitHub workflow runs PySide6 regression tests on Python 3.10, 3.11, and 3.12.

0 commit comments

Comments
 (0)