jpinedadev / readme_ejemplo

Esta es una plantilla de ejemplo para documentar tus proyectos usando un readme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool




Logo

NOMBRE DEL PROYECTO

Pequeña descripción de que hace el proyecto.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vel eros elit. Integer rutrum rhoncus porta. Phasellus interdum, dolor eu pharetra bibendum, leo dolor dignissim magna, a luctus purus ex venenatis dui.

Demo · Bugs · Features

Proyecto

enter image description here

Describir la problematica , como fue resuelta y que tecnologias se usaron.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vel eros elit. Integer rutrum rhoncus porta. Phasellus interdum, dolor eu pharetra bibendum, leo dolor dignissim magna, a luctus purus ex venenatis dui. Proin quam est, euismod non enim non, varius venenatis lacus. Duis volutpat enim non suscipit sodales. Integer imperdiet, nibh ut imperdiet molestie, ante magna facilisis justo, ac semper nulla ligula quis enim. Ut venenatis, augue sed scelerisque hendrerit, diam dui pretium dolor, a lacinia orci urna et sapien. Nulla elementum viverra pretium. Proin molestie quis dolor at venenatis. Donec consectetur nisi dolor, quis ultrices turpis laoreet vitae. Pellentesque auctor nec turpis ac sollicitudin. Cras in augue efficitur, placerat justo vel, volutpat tortor.

Tecnologías

Estas son las tecnologías que utilicé para desarrollar el proyecto.

  • HTML
  • CSS
  • NVim
  • JavaScript
  • Bootstrap

Empezando

Sigue las instrucciones para poder tener una copia y ejecutar este proyecto de forma local en tu ordenador.

Pre requisitos

Esta es la lista de dependencias que necesitas para poder ejecutar el proyecto.

  • git
      sudo apt install git
    
  • node
      sudo apt install nodejs
    
  • npm
    npm install npm@latest -g
    

Instalación

Estas son las instrucciones para poder instalar y configurar el proyecto en tu ordenador, utilizando las dependencias o servicios indicados.

  1. Ubicate en el directorio deseado ejem:(/escritorio/)
  2. Clona el repositorio
    git clone https://github.com/jpinedadev/NOMBRE_PROYECTO.git
    
  3. Instala los paquetes NPM
    npm install
    
  4. Abre la terminal y navega hasta la carpeta NOMBRE_PROYECTO
    cd NOMBRE_PROYECTO
    
  5. Ejecuta el siguiente comando
    npm start
    

Uso

Screenshots adicionales.

Ruta

  • readme
  • secciones
  • responsivo
  • optimizar
  • Modos
    • claro
    • oscuro

Lista de issues para ver las nuevas funciones y caracteristicas propuestas asi como los issues.

Contribuye

Si tienes sugerencias de que podría hacer mejor este proyecto, por favor crea un fork de este repositorio y envia un pull request, simplemente abre un issue con el tag “enhancement”.
No olvides dar una estrella a este proyecto ¡muchas gracias!.

  1. Crea un fork del proyecto
  2. Crea tu Feature Branch (git checkout -b feature/newFeature)
  3. Realiza un commit de tus cambios (git commit -m 'Add some new Feature')
  4. envia un push a la rama (git push origin feature/newFeature)
  5. Abre un Pull Request

Licencia

Mit Por la presente se concede permiso, libre de cargos, a cualquier persona que obtenga una copia de este software y de los archivos de documentación asociados

Contacto

Linkedin - @jpinedadev -
Twitter - @jpinedadev -

Link del proyecto: https://github.com/jpinedadev/NOMBRE_PROYECTO

About

Esta es una plantilla de ejemplo para documentar tus proyectos usando un readme