diff --git a/README.md b/README.md index abb2957..00b6cf5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# coffee_crisis +# Coffee Crisis -Primer dels Jailgames de nova fornada que desde el 2016 teniem intenció de traure. Es un joc en el que has de aconseguir la màxima puntuació possible amb una sola vida. Fet amb C++ i SDL2 \ No newline at end of file +Coffe Crisis es un juego arcade que pondrá a prueba tus reflejos. Realizado entre el verano de 2020 y el invierno de 2021. Intenta conseguir todos los puntos que puedas con una sola vida y ayuda a Bal1 a defender la UPV ante la invasión de la cafeína. + +## Compilar + +Para compilar el código se necesitan tener las librerías SDL instaladas en el sistema y el compilador g++. + +En Linux: +```bash +sudo apt install lib-SDL2 g++ +``` + +En macos es más facil instalarlas con [brew](https://brew.sh): +```bash +brew install sdl2 g++ +``` + +Una vez instaladas las librerías SDL, se puede compilar utilizando el fichero Makefile suministrado. + +En Linux: +```bash +make linux +``` + +En macos: +```bash +make macos +``` + +## Como ejecutar + +```bash +./bin/coffee_crisis +``` + +## Agradecimientos +A los jailers y a la jail. Y entre ellos, a JailDoctor por estar siempre ahí apoyándonos/obligándonos a sacar un Jailgame más. + +Y por supuesto a ti por estar aquí. + +## License +Buscar una licencia para que quiera haga con el código lo que le de la gana, menos sacar beneficio económico... que si lo hacen me expliquen como. \ No newline at end of file