Cómo escribir un Léeme

Un archivo “Léeme” es un documento escrito breve que se distribuye con un programa. Los archivos Léeme son escritos por los desarrolladores de programas y contienen información básica y crucial sobre el programa, incluyendo las instrucciones de instalación y configuración, información de contacto, información de licencia, reconocimientos e información sobre la versión del programa. Aprender cómo escribir un Léeme es vital para la distribución efectiva del programa. Un archivo Léeme mal escrito puede frustrar, confundir o aburrir al usuario, mientras que uno efectivo puede proveerle un aprendizaje rápido de los elementos básicos de tu programa.

Write-a-Read-Me-Step-2.jpg" class="image lightbox">

2

Incluye la fecha en tu Léeme. Este es un pequeño pero importante paso. Incluye una sola línea que contenga el año en que el programa se distribuyó. Esto alertará a los usuarios para que comprueben si hay una versión más reciente o para asegurarse de que la aplicación sigue recibiendo soporte si la fecha no es reciente.

Write-a-Read-Me-Step-3.jpg" class="image lightbox">

3

Incluye el nombre del programa, la versión y la información de precio. Cerca de la parte superior del archivo Léeme, incluye una línea con el nombre de la aplicación y el número de la versión. Debajo de eso, incluye una línea con el precio de la versión completa. Si distribuyes el programa usando un medio físico, como CD, puedes omitir la información de precio, pues el usuario probablemente ya pagó por el programa.

Write-a-Read-Me-Step-4.jpg" class="image lightbox">

4

Describe el programa de una forma breve y convincente. Usa solo una o dos oraciones, incluye la descripción del programa. Un ejemplo puede ser: “Esta aplicación determina el humor del usuario al registrar sus acciones en línea, después altera el ambiente del escritorio para adaptarlo a este estado de ánimo”.

Write-a-Read-Me-Step-5.jpg" class="image lightbox">

5

Proporciona los requisitos básicos para la instalación de tu programa. Un buen Léeme también debe incluir la información sobre los requisitos del sistema y las instrucciones de instalación. Si otra parte del programa es necesaria para ejecutar el programa, menciónalo aquí. También puedes incluir información sobre el uso de recursos esperados (por ejemplo, el uso del CPU).

Write-a-Read-Me-Step-6.jpg" class="image lightbox">

6

Incluye cualquier derecho de autor o información de licencia. Finalmente, asegúrate de proporcionar la fecha del derecho de autor y qué acuerdo de licencia de programa regula el uso de tu programa.