Título principal del proyecto ( # )

Párrafo para la descripción de secciones o del proyecto en general (Se hace con guión bajo al inicio y fin). Este apartado nos sirve para dar una descripción general del proyecto

Este es un subtítulo ( ## )

Esta es la descripción del subtitulo, esta propiedad nos permite extendernos de la manera mas prolongada o breve de lo que queremos explicar, y no tiene un limite. Esta sección nos sirve para especificar los detalles del proyecto y darle realce a los mismos.

Para marcar con Negrita debemos usar los asteriscos (** **)

Resaltar en enmarcado

Si necesitamos resaltar el código en una caja de texto donde este permanesca aislado, podemos utilizar el asento grave (```)

Ejemplo:

git init

Agregar imagenes

Se pueden agregar imagenes de la misma manera y propiedades como las que utilizamos en HTML. Ejemplo:

Nota: Con acento grabe (`) podemos darle un resalte diferente a las palabras de un párrafo

Tercer subtitulo ( ### )

Para esta sección, se suelde dar a los detalles técnicos y códigos para procedimientos y iniciación del proyecto. Este proceso se llama Instalación

Ejemplo

pip install python
python -m pip install Django

Tablas de contenido

Podemos agregar tablas de contenido como la siguiente:

Expandir

Titulo:
Agradecimientos

Otras secciones para el README

Estas son otras secciones que se pueden incluir par adetallar el desarrollo y aplicativo del sistema en el documento

Ejecución de pruebas

Explica como aplicar y el por que de las pruebas del sistema

Pruebas end-to-end (E2E)

Esta es la esquematización del flujo que lleva el proyecto, dinde se explica el por qué de su funcionamiento. Además de brindar un simulacro del comportamiento completo del sistema, de inicio a fin

Estilo de codificación

Es una explicación de la nomenclatura y tipo de orden que se llevo durante el desarrollo del proyecto

Ejemplo de nomenclatura de modelos:

class ejemplo_model (models.Model):
    id_ejemplo	= models.AutoField(PrimaryKey = True)
    nombre = models.CharField(max_length=30)
    apellido = models.CharField(max_length=30)

Despliegue

Son las configuraciones necesarias para poner en producción el proyecto

Construido con:

Se mencionan las herramientas con las que se desarrollo la app. Nota: Para poner una lista en el rreadme debemos usar un asterisco y para agregar un link usamos Corchetes y Paréntesis

Django - Framework utilizado
Python - Manejador de dependencias

Otras campos a mencionar

Contribuyendo: Algunas directrices para leer detalles del codigo
Wiki: Más informacion de como utilizar nuestro proyecto
Versionado: Metodologia que se emplea para dar los tags de actualizacion de versiones del proyecto

Autores

Aqui se mencionan a todas las personas que ayudaron y contribuyeron en el desarrollo del sistema

Ernesto Flores - Desarrollador Frontend - ErnestoFlo
Fulanito Detal - Documentación - fulanitodetal

Licencia

Este proyecto está bajo la licencia (Mi licencia) - Mira el archivo LICENSE.md para detalles

Expresiones de Gratitud

Comentarios sobre este proyecto
Menciones y agradecimeintos a miembros del equipo.
Dar las gracias públicamente.
etc.

ErnestoFlo/CB-Readme