diff --git a/README.md b/README.md index 5737206..41ba582 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,66 @@ -# Coffee Crisis Arcade Edition +# Coffee Crisis -Coffee Crisis Arcade Edition es la versió ampliada i millorada del aclamat Coffee Crisis. Preparat per a jugar sense parar amn dos jugadors, nous gràfics i moltes sorpreses mes. +Coffee Crisis és un joc arcade que posarà a prova els teus reflexos. Començat durant l'estiu de 2020 i acabat un any després a l'estiu de 2021. Intenta aconseguir tots els punts que pugues amb una sola vida a través dels 10 nivells de joc i ajuda a Bal1 a defensar la UPV de la invasió de la cafeïna esfèrica i saltarina. -
-
+
-## Controls
-El joc està optimitzat per a ser jugat amb un mando de jocs, encara que un dels jugadors pot utilitzar el teclat.
-Les tecles son les següents:
+## Teclat
-* **Cursors**: Mou al personatge
-* **Q, W, E**: Disparar a la esquerra, al centre i a la dreta respectivament
-* **ESCAPE**: Per a tancar el joc
-* **ENTER**: Acepta las opciones en los menus
+El joc es maneja amb teclat, encara que també es pot connectar un comandament de control.
+Les tecles són les següents:
+* **Fletxes**: Moure el personatge, moure's pels menús
+* **Q, W, E**: Disparar a l'esquerra, al centre i a la dreta respectivament
+* **ESCAPE**: Posa en pausa el joc durant la partida. Surt dels menús. Tanca el joc
+* **ENTER**: Accepta les opcions en els menús
-
+
-## Altres tecles
+## Compilar
+Per compilar el codi cal tindre les biblioteques SDL instal·lades al sistema i el compilador g++.
+En Linux:
+```bash
+sudo apt install libsdl2-dev g++
+```
-
+En macOS es poden instal·lar fàcilment amb [brew](https://brew.sh):
+```bash
+brew install sdl2 g++
+```
-## Mes coses
+Un cop instal·lades les biblioteques SDL, es pot compilar utilitzant el fitxer Makefile subministrat.
+En Linux:
+```bash
+make linux
+```
+En macOS:
+```bash
+make macos
+```
+
-## Agraiments
-A chatGPT i sobretot a Copilot. Gracies per estar sempre ahi quan vos he necesitat.
+## Com executar
+
+Per executar el joc cal escriure a la terminal l'ordre que es mostra a continuació.
+
+En Linux:
+```bash
+./coffee_crisis_linux
+```
+
+En macOS:
+```bash
+./coffee_crisis_macos
+```
+
+En macOS també pots fer doble clic sobre l'arxiu coffee_crisis_macos
+
+## Agraïments
+Als jailers i a la jail. I entre ells, a JailDoctor per estar sempre donant-nos suport/obligant-nos a traure un Jailgame més.
+
+I per descomptat a tu per estar aquí.
+
+## Llicència
+Utilitza el codi per a el que vulgues: aprendre, riure't, tafanejar... excepte per treure'n benefici econòmic. Si ho aconsegueixes, si us plau avisa'm i anem a mitges.
\ No newline at end of file