Skip to content

docs: reestructurar README orientado al usuario (VIS-002) - #17

Merged
ChristianM023 merged 2 commits into
mainfrom
docs/vis-002-readme
Aug 21, 2026
Merged

ChristianM023 merged 2 commits into
mainfrom
docs/vis-002-readme

Conversation

@ChristianM023

Copy link
Copy Markdown
Owner

VIS-002 — Corregir README, versiones e instalación

Reestructuró el README público orientándolo al usuario final, corrigió la versión de descarga desactualizada y añadió contenido de activación.

Cambios

  • TL;DR en las primeras 20 líneas: qué es, por qué existe, cómo instalarlo.
  • Sección Install movida antes de How it works (antes los detalles técnicos del parser estaban arriba).
  • How it works reducida a resumen orientado al usuario (los detalles del parser/daemon ya viven en Development al final).
  • Enlace Debian corregido de 0.1.7 a 0.1.10.
  • Sección Quick test añadida con ejemplo de notify-send.
  • Sección Compatibility añadida (matriz: GNOME validado, KDE/XFCE/Cinnamon/MATE por probar).
  • Sección Privacy añadida (procesamiento local, sin red, sin telemetría, sin persistencia del cuerpo).

Verificación

  • scripts/quality.sh — py_compile OK (6 archivos).
  • scripts/test-all.sh — 89 tests OK.
  • grep -n '0\.1\.7' README.md — sin enlaces de descarga desactualizados.

Closes VIS-002.

- TL;DR (qué/por qué/instalar) en las primeras 20 líneas
- Sección Install movida antes de How it works
- How it works reducida a resumen orientado al usuario
- Enlace Debian corregido de 0.1.7 a 0.1.10

Parte de VIS-002 (criterios 1, 2, 3, 7).
…dad, privacidad)

- Sección Quick test con ejemplo de notify-send
- Matriz de compatibilidad (GNOME validado, otros por probar)
- Sección de privacidad (local, sin red, sin telemetría)

Parte de VIS-002 (criterios 4, 5, 6).
@ChristianM023
ChristianM023 merged commit eccef65 into main Aug 21, 2026
1 check passed
@ChristianM023
ChristianM023 deleted the docs/vis-002-readme branch August 21, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant