Escribir un README.md

Vamos a ver como escribir un readme, es decir, como hacer un readme usando varias herramientas que tiene el mismo.

Necesitas conocimiento básicos en github, HTML y CSS. 


Títulos

Al tener nuestro documento creado (para hacerlo solo creamos un nuevo archivo y lo llamamos README.md) entonces para los títulos es:

    # h1            #### h4            

    ## h2          ##### h5

    ### h3        ###### h6

Decoración de texto

Para hacer texto en negrita, itálica o las 2, hacemos:

    *Itálica*    **Negrita**    ***Itálica y negrita***

Escritura de código

Para escribir código y que se denote que lo es, haremos lo siguiente: escribiremos el código normal, ahora a todo el código le haremos tabulador (espacio doble) y cambiara a su formato automáticamente.


Citas de texto

Para escribir una cita solo agregamos un símbolo:
    > Esta es una cita y usa el mayor que.


Listas

Para hacer una lista la podemos hacer organizada o no, para una lista organizada a cada elemento le pondremos un numero:

    1. Elemento uno.

    2. Elemento dos.

Para una lista no organizada usamos asterisco:

    * Elemento uno.

    * Elemento dos.

Se pueden intercalar las tipos de lista.


Enlaces editados

Para poner un enlace y que no se vea como tal el enlace sino un texto para acceder, hacemos:

    [Texto del enlace](https://enlace.com)


Imágenes por enlace

Para poner imágenes vía internet, haremos lo mismo que los enlaces pero con un pequeño cambio: 

    ![Nombre foto](https://enlace_imagen.jpg)

 

Recuadros de anotaciones

Son un pequeño campo el cual podemos destacar de diferentes formas, tenemos:

  • Nota (NOTE).
  • Tip (TIP).
  • Importante (IMPORTANT).
  • Advertencia (WARNING).
  • Precaución (CAUTION).

Ahora, como podemos usarlo, es sencillo solo tenemos que seguir el ejemplo:

> [!TIP]

> Este es un consejo

Escribimos los mayor que, elegimos cual opción queremos, y escribimos su texto. Queda así:




Aprendimos a hacer un REDME.md de manera rápida y elemental. Algo a tener en cuenta es que este formato tiene un etiquetado, es decir, tienen un CSS que se puede editar a gusto y dar mas opciones al documento, pero esto es más complicado y toma mas tiempo, además es más que todo para decorar el documento, pero con lo aprendido podemos hacer correctamente un README.md.