Add README

This commit is contained in:
Sofía Aritz 2024-10-10 20:23:02 +02:00
parent ad6a97c297
commit 268d2ff5f4
Signed by: sofia
GPG key ID: 90B5116E3542B28F

33
README.md Normal file
View file

@ -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
```