Sobre el proyecto
tldr-pages es un proyecto colaborativo que recopila páginas de ayuda mantenidas por la comunidad para herramientas de línea de comandos. Su objetivo es ser un complemento más simple y accesible a las páginas man tradicionales, centrándose en ejemplos prácticos en lugar de manuales exhaustivos. El repositorio contiene un conjunto en constante crecimiento de ejemplos para herramientas comunes en las interfaces de línea de comandos de UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android, Windows, Cisco IOS y DOS.
El README explica que el proyecto fue motivado por la dificultad de leer las páginas man típicas, donde la primera explicación podría tratar sobre tamaños de bloque de unidades de cinta en lugar del uso común que los usuarios necesitan. En cambio, las páginas de tldr muestran ejemplos concisos y cotidianos, como extraer un archivo tar.
Las opciones de uso incluyen clientes oficiales:
- Cliente de Python: instalable con pipx u otros gestores de paquetes
- Cliente de Rust (tlrc): instalable con Homebrew, Cargo o Winget en Windows
- Cliente de Node.js: npm install -g tldr, aunque se ha quedado atrás en actualizaciones
Los usuarios también pueden navegar a través del cliente web en tldr.inbrowser.app, que admite uso sin conexión mediante PWA, o descargar una versión en PDF de las páginas desde la última versión. Los PDF de las traducciones están disponibles para la mayoría de los idiomas.
La contribución está abierta a todos. Las formas de contribuir incluyen añadir comandos favoritos que aún no estén cubiertos, mejorar páginas existentes, trabajar en issues etiquetados como "help wanted" y traducir páginas a diferentes idiomas. Las páginas están escritas en Markdown, por lo que se pueden editar fácilmente y enviar mediante pull requests. El proyecto enfatiza una comunidad acogedora y colaborativa, con guías de contribución y documentación de gobernanza. También hay disponible un sitio de progreso de traducciones y salas de chat de Matrix.
El README también enumera proyectos similares como cheat.sh, devhints, eg, kb, navi, cheat, Command Line Interface Pages y el obsoleto bropages.
El nombre TL;DR significa "Too Long; Didn't Read", lo que refleja el propósito del proyecto de proporcionar ayuda de comandos rápida y legible en lugar de documentación extensa.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.