AMIGALANDIA

AMIGALANDIA --- Blog Retrospectivo Amiga/MorphOS

miércoles, 24 de junio de 2015

El fichero Readme de Aminet

Contenidos

  • 1.Introducción
  • 2 Short:
  • 3 Author:
  • 4 Uploader:
  • 5 Type:
  • 6 Architecture:
  • 7 Replaces:
  • 8 Requires:
  • 9 Version:
  • 10 Distribution:
  • 11 Kurz:

1.- Introducción

Todo fichero readme comienza con algunas líneas que ofrecen una breve descripción, inteligible para el ordenador, sobre diversas propiedades o atributos del fichero a subir. Dichas líneas, también referidas como "campos", van seguidas de una línea en blanco. A continuación, puede incluir una pequeña introducción sobre su envío, incluyendo su nota de derechos de copia o simplemente añadiendo cualquier documentación que vaya incluida en el archivo. Este es el aspecto típico de un fichero readme de Aminet:

Short:        Shows JPEG & IFF pics. AGA support
Uploader:     aminet@aminet.net (Urban Mueller)
Author:       aminet@aminet.net (Urban Mueller)
Type:         gfx/show
Version:      1.2
Architecture: m68k-amigaos >= 2.0.4
Distribution: Aminet
Kurz:         Zeigt JPEG und IFF an, AGA-Support

This all new picture displayer is capable of showing almost any image
type in any resolution. Main features include:
- Scrolling screens
- CLI and WB interface
 ......

Este ejemplo muestra los campos que se pueden utilizar en el fichero readme, y luego una descripción detallada prosigue a continuación más abajo. Algunos de los campos son absolutamente imprescindibles (esto es, corre el riesgo de que su subida se elimine si no los indica), otros se recomiendan y otros son completamente opcionales.

2.- Short:

Este campo debe formar la primera línea del fichero readme. Permite indicar una breve descripción del archivo para mostrarla en el árbol de directorios de Aminet, y en nuestros boletines electrónicos de noticias diarios y semanales. Dicha descripción no debe sobrepasar los 40 caracteres. No repita el nombre del fichero en este campo y tampoco incluya números de versión o plataformas de destino - intente explicar el cometido del programa. Si se trata de Música debería indicar el estilo y autor.  No presuma ni abuse de las mayúsculas.
Si su archivo precisa otro lenguaje que no sea el Inglés, mencione dicho lenguaje en la descripción Short:.

3.- Author:

Campo reservado para indicar el creador del software que vamos a subir. Se puede incluir opcionalmente una dirección de correo electrónico, pero recuerde que no se ocultará, p.ej. podría ser recopilado por robots spam.

4.- Uploader:

Indique su dirección de correo electrónico para ponernos en contacto con usted si hubiera algún problema (algo que sucede más a menudo de lo que imagina). Debe indicar una dirección de correo electrónico totalmente, no semi oculta. No tema recibir cientos de correos SPAM; Se eliminarán de su correo electrónico los caracteres "@" y "." del fichero readme antes de añadirse al archivo de Aminet. De esta forma permanece legible para las personas, pero inútil para robots spam.

5.- Type:

Aquí debe indicar el directorio de destino de la subida que quiere realizar. Compruebe el índice de directorios de Aminet para obtener una lista de los valores posibles.

6.- Architecture:

Campo destinado a indicar la arquitectura a la que va dirigida su archivo. Le mostramos una lista de posibles arquitecturas de destino:
  • m68k-amigaos
  • ppc-amigaos
  • ppc-morphos
  • ppc-powerup
  • ppc-warpup
  • i386-aros
  • i386-amithlon
  • generic
Si el archivo no contiene ningún binario, debería utilizar "generic". Si el paquete incluyese binarios para más de una plataforma, sería necesario indicar las arquitecturas apropiadas. Se pueden listar varias arquitecturas, separadas por punto y coma. Ejemplos:

Archivo que contenga binarios para AmigaOS Clásico:
Architecture: m68k-amigaos
Archivo que contenga binarios para MorphOS:
Architecture: ppc-morphos
Archivo que contenga binarios para AmigaOS 4 y WarpUp:
Architecture: ppc-amigaos; ppc-warpup
Nota: sólo debe indicar arquitecturas para las que el binario de su archivo fue compilado. No debe indicar arquitecturas con las que sus binarios puedan ser compatibles. Si sube un binario para m68k-amigaos, esa es la única arquitectura que debe mencionar - sin importar si el binario también funciona sobre otras plataformas (AmigaOS 4, MorphOS) bajo emulación.
Se puede añadir a cada arquitectura que especifique una cadena de texto de versión junto a un modificador (>=, >, =, <, <=), para señalar el número de versión máximo o mínimo necesario para ejecutar el programa. Ejemplos:

Archivo que contenga binarios para MorphOS 1.4 o superior:
Architecture: ppc-morphos >= 1.4.0
Archivo que contenga binarios para AmigaOS 3.9 y AmigaOS 4.0 o superior:
Architecture: m68k-amigaos >= 3.9.0; ppc-amigaos >= 4.0.0
Archivo que contenga binarios para AmigaOS 1.3 o inferior:
Architecture: m68k-amigaos <= 1.3.3
Resumiendo, la plantilla para la arquitectura presenta campos con este aspecto:
Architecture: ARCH1 [MODIFICADOR VERSIÓN] [; ARCH2 [MODIFICADOR VERSIÓN] ... ]
Nota Final: Aunque se permita, no recomendamos agrupar binarios para diferentes plataformas en el mismo archivo - si fuera posible, genere un archivo exclusivo para cada arquitectura. Un buen ejemplo podría ser la versión Quake de Frank Wille.

7.- Replaces:

Indique aquí los ficheros que desea reemplazar con su nueva subida. Proporcione la ruta completa, se permiten los comodines de Unix en el nombre del fichero. Ejemplos:
Replaces: biz/patch/PageStreamPatch1.lha
Replaces: biz/patch/PageStreamPatch*
Puede indicar varios nombres de ficheros, separados por punto y coma. No es necesario indicar en este campo que vamos a sobrescribir un fichero ya existente que cuenta con idéntico nombre que el que desea subir.

8.- Requires:

Puede indicar qué otros ficheros de Aminet son necesarios para el funcionamiento de su programa, siempre con la ruta completa. Ejemplo:
Requires: util/libs/mui38usr.lha
Incluya también los requisitos de memoria y juego de chips.

9.- Version:

Número de versión de su archivo. No emplee números de versión en los nombres de los ficheros siempre que sea posible.

10.- Distribution:

Existen dos valores legales para este campo, "NoCD" y "Aminet" - no debe indicar nada más.  Con "Distribution: NoCD", se asegura de que su distribución no sea incluida en los CD's o DVD's creados por el equipo de Aminet. Con "Distribution: Aminet" se restringe la distribución del archivo exclusivamente a Aminet (incluyendo los CDs de Aminet y otros medios), es decir, puede evitar así que otros grupos lo redistribuyan.

11.- Kurz:

Es la versión Alemana de Short: (ver al comienzo).

Traducción del documento: http://wiki.aminet.net/The_Readme_file