Acabo de bifurcar un proyecto en Github, hice mis cambios, etc. Esto me hizo preguntarme: veo principalmente README. txt en proyectos de código abierto y el archivo que edité era Readme.txt. ¿Es esto algún tipo de estandarización o debería haberlo dejado como está?
Comentarios
- Probablemente todo en mayúsculas tuvo su comienzo en MS-DOS, todo en minúsculas probablemente de la herencia de Unix. No estoy seguro de la primera letra en mayúscula: raíces de Mac, tal vez. Al final, no ' realmente importa, excepto por una cuestión de orden o estilo.
Respuesta
Las letras en mayúsculas se destacan y hacen que el archivo sea fácilmente visible, lo cual tiene sentido porque es probablemente lo primero que un nuevo usuario querría ver. (O, al menos, debería haber mirado…) Como ya han dicho otros, los nombres de archivo que comienzan con una letra mayúscula aparecerán antes de los nombres en minúsculas en Clasificación ASCIIbetical (LC_COLLATE=C) que ayuda a que el archivo sea visible a primera vista.
El README es parte de un grupo de archivos que un usuario de un paquete de software gratuito normalmente esperaría encontrar. Otros son INSTALL (instrucciones para compilar e instalar el software), AUTHORS (lista de contribuyentes), COPYING (texto de la licencia), HACKING (cómo empezar a contribuir, tal vez incluyendo una lista de TODO de puntos de partida), NEWS (cambios recientes) o ChangeLog (en su mayoría redundante con los sistemas de control de versiones).
Esto es lo que Estándares de codificación GNU tienen que decir sobre el archivo README.
La distribución debe contener un archivo llamado
READMEcon una descripción general del paquete:
- el nombre del paquete;
- el número de versión del paquete, o hacer referencia a dónde se puede encontrar la versión en el paquete;
- una descripción general de lo que hace el paquete;
- una referencia al archivo
INSTALL, que debería en tur n contener una explicación del procedimiento de instalación;- una breve explicación de cualquier directorio o archivo de nivel superior inusual, u otras sugerencias para que los lectores encuentren la fuente;
- a referencia al archivo que contiene las condiciones de copia. La GNU GPL, si se usa, debe estar en un archivo llamado
COPYING. Si se usa GNU LGPL, debería estar en un archivo llamadoCOPYING.LESSER.
Dado que siempre es bueno esforzarse por lograr la menor sorpresa de sus usuarios, debe seguir esta convención a menos que haya razones de peso para una desviación. En el mundo UNIX, las extensiones de nombre de archivo se usaban tradicionalmente con moderación, por lo que el nombre canónico del archivo es README sin ningún sufijo. Pero la mayoría de los usuarios probablemente no tendrán problemas para entender que un archivo llamado README.txt tiene el mismo significado. Si el archivo está escrito en Markdown , un nombre de archivo como README.md también podría ser razonable. Sin embargo, evite usar lenguajes de marcado más complicados como HTML en el archivo README, porque debería ser conveniente leer en una terminal de solo texto. Puede indicar a los usuarios el manual del software o su documentación en línea, que puede estar escrito en un formato más sofisticado, para obtener detalles del archivo README.
Respuesta
Tradicionalmente, el archivo se llamaba README en mayúsculas porque los entornos de línea de comandos que usaban el orden alfabético colocaban el archivo en la parte superior. Esto los hace fácilmente visibles en directorios grandes.
Lo más probable es que sea un vestigio del mundo Unix / Linux donde descargaría fuentes y luego construiría su software. Tener archivos como README e INSTALL en la parte superior de la vista de «lista de contenidos del directorio» lo convierte en Es más fácil ver que están allí, en lugar de tener que navegar por todo el contenido desde una interfaz de línea de comandos. El mismo principio básico también funciona para github (y en realidad también funciona en interfaces GUI, ahora que lo pienso, así que podría todavía tienen mérito)
De ninguna manera es una regla estricta, pero es muy probable que sea algo que todos hacen como un hábito porque otros proyectos lo están haciendo. A menos que haya alguna razón explícita para NO hacerlo, probablemente debería usar todas caps solo porque verá que se usa de esa manera en muchos otros proyectos. También es el nombre predeterminado que Github usa cuando creas un nuevo repositorio.
Comentarios
- I ' siempre pensé que todo en mayúsculas era una forma de énfasis, muy parecido a cómo se tienen las secciones de mayúsculas en la jerga legal.
- En una interfaz de línea de comandos, los archivos que van a la parte superior de la lista son en realidad los que se desplazan fuera de la vista primero, por lo que a veces estos son los archivos menos visibles. A menos que siempre haga algo como
ls -l | less.
Responder
README generalmente se escribe en mayúsculas. De esta manera, el comando ls Unix colocó el archivo cerca del principio de la lista del directorio (las letras mayúsculas van antes de las minúsculas en el orden ASCII).
Comentarios
- Esta fue la razón histórica, pero
lsno ' t normalmente se clasifican de esa manera en los sistemas modernos. - @ dan1111 ¡Correcto! Gracias (solo para probar …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)