From 98bfe2e714f5944ba825d168d6669ba788d6f394 Mon Sep 17 00:00:00 2001 From: "Mauro Rosero P." Date: Sat, 5 Apr 2025 20:12:12 -0500 Subject: [PATCH] =?UTF-8?q?[DOCS]=20Mejoras=20en=20README:=20secci=C3=B3n?= =?UTF-8?q?=20licencia=20y=20herramientas=20CLI?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Ampliada sección de licencia con detalles y enlaces a LICENSE.md - Añadida sección para Glow (renderizador de Markdown) junto a Gum - Creada categoría 'Herramientas de CLI Modernas' para agrupar utilidades de Charm - Añadidos ejemplos de uso para ambas herramientas - Actualizada referencia a herramientas en la sección de bootstrap.sh 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 46 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7ffaa97..e63a457 100644 --- a/README.md +++ b/README.md @@ -64,13 +64,20 @@ MRDevs Tools utiliza una estructura organizada que separa el código (en ~/devs) | Comando | Descripción | |---------|-------------| | `bin/bootstrap.sh` | Instala herramientas básicas (incluyendo oathtool, zbar, redis-cli, gum y glow) y configura la gestión de contenedores | -| `bin/update.sh` | Actualiza el entorno de desarrollo y herramientas (incluyendo oathtool, zbar, redis-cli y gum) | +| `bin/update.sh` | Actualiza el entorno de desarrollo y herramientas (incluyendo oathtool, zbar, redis-cli, gum y glow) | | `bin/npm_install.sh` | Instala NodeJS y npm de forma interactiva | | `bin/project_new.sh` | Crea un nuevo proyecto con estructura estandarizada según el tipo seleccionado | -### Interfaces de Usuario con Gum +### Herramientas de CLI Modernas -MRDevs Tools utiliza [Gum](https://github.com/charmbracelet/gum) para crear interfaces de texto (TUI) elegantes y funcionales: +MRDevs Tools integra herramientas modernas de Charm para mejorar la experiencia en la línea de comandos: + +| Herramienta | Descripción | +|---------|-------------| +| [Gum](https://github.com/charmbracelet/gum) | Toolkit para interfaces TUI elegantes y funcionales | +| [Glow](https://github.com/charmbracelet/glow) | Renderizador de Markdown para terminal con soporte para temas y paginación | + +#### Interfaces de Usuario con Gum | Comando/Documento | Descripción | |---------|-------------| @@ -151,13 +158,22 @@ MRDevs Tools utiliza [Gum](https://github.com/charmbracelet/gum) para crear inte ## 📚 Guía de Usuario -### Interfaces de Texto con Gum +### Herramientas de CLI Modernas -MRDevs Tools incluye soporte completo para [Gum](https://github.com/charmbracelet/gum), una herramienta que permite crear interfaces de texto (TUI) elegantes: +MRDevs Tools incluye soporte completo para herramientas modernas de CLI de [Charm](https://charm.sh/): + +#### Gum - Interfaces de Texto Elegantes + +[Gum](https://github.com/charmbracelet/gum) permite crear interfaces de texto (TUI) elegantes y funcionales: ```bash # Abrir el tutorial completo sobre Gum xdg-open ~/devs/docs/forms-gum.md + +# Ejemplos rápidos +gum style --border normal --margin "1" --padding "1 2" "Texto con estilo" +gum input --placeholder "Ingresa tu nombre" +gum confirm "¿Deseas continuar?" && echo "Has confirmado" || echo "Has cancelado" ``` El tutorial incluye: @@ -166,7 +182,22 @@ El tutorial incluye: - Técnicas para estilizar texto y crear layouts complejos - Referencias visuales de cada componente -Para más detalles, consulta la [documentación completa de Gum](docs/forms-gum.md). +#### Glow - Renderizador de Markdown + +[Glow](https://github.com/charmbracelet/glow) es un renderizador de Markdown para la terminal: + +```bash +# Visualizar un archivo Markdown +glow README.md + +# Visualizar con tema oscuro +glow -s dark README.md + +# Modo paginado para documentos largos +glow -p LICENSE.md +``` + +Para más detalles, consulta la [documentación completa de estas herramientas](docs/forms-gum.md). ### Preparación del Entorno @@ -660,7 +691,15 @@ Para contribuir al proyecto: ## 📄 Licencia -Este proyecto está licenciado bajo la Licencia Pública General Affero (AGPL) - vea el archivo LICENSE para más detalles. +Este proyecto está licenciado bajo la [GNU Affero General Public License v3.0](LICENSE.md) (AGPL-3.0). + +La licencia AGPL-3.0 garantiza que: +- Puedes usar, modificar y distribuir este software libremente +- Si modificas el software y lo distribuyes o lo ofreces como un servicio de red, debes publicar el código fuente completo +- Cualquier software derivado debe mantener la misma licencia AGPL-3.0 +- Se preservan los derechos de autor originales + +El texto completo de la licencia está disponible en el archivo [LICENSE.md](LICENSE.md) del repositorio. ## 👥 Colaboradores