Del curso: Visual Studio: Integración Git esencial

Edición del archivo README.md en GitHub

El archivo 'readme' es el primer documento que un desarrollador debería mirar antes de comenzar a trabajar en un proyecto. En esta lección aprenderemos a editarlo desde la interfaz visual de GitHub. Para editar el archivo 'readme' desde la interfaz visual de GitHub, accedemos a la URL del repositorio en cuestión, hacemos clic sobre el archivo y a continuación pulsamos sobre el botón de editar. Los archivos 'readme' se escriben con formato "markdown". El formato "markdown" es un formato de escritura que permite la generación de una salida en HTML sin necesidad de aprender HTML. Editar un archivo 'readme' en formato "markdown" es realmente sencillo. Si nos fijamos, los títulos comienzan con almohadillas. Dependiendo del número de almohadillas que escribamos, tendremos un texto de nivel uno, un texto de nivel dos o un texto de nivel tres, y podríamos llegar hasta el nivel seis. Los párrafos se escriben como cualquier otro texto y no necesitan de ningún símbolo especial. Lo único que es bueno saber es que el formato en negrita se indica con dos asteriscos al comienzo y al final de la palabra o frase que queramos marcar como negrita, la cursiva con solo un asterisco al comienzo y al final, y las negritas con cursiva con dos asteriscos y un guion bajo. E incluso también podemos utilizar listas ordenadas y no ordenadas. Las listas ordenadas se indican con números y las listas no ordenadas se indican con un asterisco. Existen multitud de signos que nos permitirán maquetar el archivo 'readme' a nuestro gusto. Te invito a que investigues todas las opciones disponibles y practiques creando archivos 'readme' para cada uno de tus repositorios. Para guardar las modificaciones realizadas en este archivo solo necesitamos anotar los cambios. El archivo 'readme' es el primer documento que un desarrollador debería mirar antes de comenzar a trabajar en un proyecto, y en esta lección hemos aprendido a editarlo desde la interfaz de GitHub.

Contenido