From e044cf37e33e469c21abdc63af19e9173be3ceea Mon Sep 17 00:00:00 2001 From: diegoalrv Date: Wed, 22 Nov 2023 21:49:18 -0300 Subject: [PATCH] update README.md --- README.md | 64 +++++++++++++++++++++++-------------------------------- 1 file changed, 27 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 66c0187..c833d88 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,39 @@ -# Visualización para pantallas LED de paradas de bus +# Visualización para Pantallas LED de Paradas de Bus -Este repositorio contiene los archivos necesarios para ejecutar una aplicación Jupyter Notebook con ciertas bibliotecas de visualización y procesamiento de imágenes. +Este proyecto genera visualizaciones para pantallas LED en paradas de autobuses, mostrando información como tiempos de llegada y detalles de rutas. -## Contenido +### Paso 1: Clonar el Repositorio -- `Dockerfile`: Define cómo construir la imagen Docker para ejecutar la aplicación. -- `requirements.txt`: Lista las bibliotecas y dependencias necesarias para la aplicación. +Para comenzar, clona el repositorio y navega a su directorio: -## Dockerfile +```bash +git clone https://github.com/diegoalrv/pantallas-led +cd pantallas-led +``` -### Descripción +## Tabla de Contenidos +1. [Montaje y Funcionamiento de Pantallas](#montaje-y-funcionamiento-de-pantallas) +2. [Generación de Póster de Bus](#generación-de-póster-de-bus) +3. [Comunicación y Configuración](#comunicación-y-configuración) -El `Dockerfile` especifica cómo construir una imagen Docker basada en Python 3.8 que tiene todas las dependencias necesarias para ejecutar la aplicación. +## Montaje y Funcionamiento de Pantallas +*Contenido pendiente.* -### Instrucciones +## Generación de Póster de Bus +En el directorio raiz del respositorio seguimos los siguientes pasos: -1. **Imagen base**: Utiliza Python 3.8. -2. **Directorio de trabajo**: Establece `/app` como el directorio de trabajo en el contenedor. -3. **Instalación de dependencias**: Copia y utiliza `requirements.txt` para instalar las bibliotecas necesarias. -4. **Configuración de Jupyter**: Copia el archivo de configuración de Jupyter al contenedor. -5. **Puerto**: Expone el puerto 8888 para Jupyter Notebook. -6. **Comando de inicio**: Al iniciar el contenedor, se ejecuta Jupyter Notebook en el puerto 8888. +### Construir la Imagen Docker +Primero, construye la imagen Docker que contiene todas las dependencias necesarias: -## requirements.txt +```bash +docker build -t bus_poster . +``` -### Descripción +### Ejecutar el Contenedor Docker +Utiliza el script run_container.sh para ejecutar el contenedor. Este script monta las carpetas locales necesarias y inicia el contenedor. El contenedor se eliminará automáticamente después de su ejecución debido al parámetro --rm. -El archivo `requirements.txt` lista las bibliotecas y dependencias que se requieren para la aplicación. +```bash +./run_container.sh +``` -### Bibliotecas y dependencias - -- `matplotlib`: Biblioteca de visualización de datos. -- `seaborn`: Biblioteca de visualización de datos basada en matplotlib. -- `plotly`: Biblioteca para gráficos interactivos. -- `opencv-python`: Biblioteca de procesamiento de imágenes y visión por computadora. -- `jupyter`: Entorno de desarrollo interactivo. - -## Cómo ejecutar - -1. Construye la imagen Docker: - -`docker build -t bus_stop_visualization .` - -2. Ejecuta el contenedor: - -`docker run -d --name bus_stop_vis -v /scripts:/app/scripts -p 8888:8888 bus_stop_visualization` - -3. Abre un navegador y accede a `http://localhost:8888` para comenzar a usar Jupyter Notebook. \ No newline at end of file +Nota: Asegúrate de que el script ```run_container.sh``` tenga permisos de ejecución. Si no es así, ejecuta: