diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc3a7e9 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Hackathon 2024 (ASL) + +## Introducción + +La Hackathon del ASL es parte del Hacktoberfest que organizan todos los años, donde se realizan charlas, talleres y actividades como esta. + +Las indicaciones de la Hackathon han sido las siguientes: +1. Trabajar en Python +2. Utilizar la librería [`pillow`](https://pypi.org/project/pillow/) +3. Realizar el proyecto el ~2 horas + +## Proyecto + +El proyecto realizado consiste en una aplicación gráfica que realiza una captura de pantalla y te indica dos opciones: guardar en el _clipboard_ el texto detectado +en la imagen mediante OCR y/o guardar la captura de pantalla en un servidor remoto para poder compartirla con tus compañeros y/o amigos. + +## Instalación y ejecución + +Los requisitos para ejecutar este proyecto son: +* Python 3 (3.11) +* `pillow` +* `tkinter` +* (En entornos Wayland) `gnome-screenshot` + +Para ejecutar el servidor, se utiliza el siguiente comando: +```sh +python main.py --server=True +``` + +Para ejecutar el _cliente_ (el encargado de tomar la captura de pantalla): +```sh +python main.py +``` \ No newline at end of file