Commit 84f8b423 authored by Mathieu Féry (Mathius)'s avatar Mathieu Féry (Mathius)
Browse files

Update README

parent 82e410f0
Pipeline #23325 failed with stages
in 2 minutes and 48 seconds
......@@ -39,10 +39,28 @@ Cette activité affiche les détails et les GIF associés du GIF sélectionné d
En dessous, une liste déroulante de GIF associé.
Le click sur l'un des GIf de la liste aura pour effet de remplacé par ce GIF, celui associé à la fiche personnage. L'activité `DisplayGIF` sera alors fermé et nous reviendrons sur l'activité `DisplayResult`.
## Pré-requis
Attention pour pouvoir exploiter pleinement notre dépôt nous vous conseillons soit d'exploiter l'un des fichiers .apk provenant des releases ou des pipelines de master.
Cependant si vous souhaiter développer ou faire avancer notre projet, il vous faudra :
* Créer un fichier nommé `apikey.properties` (Qui est ignoré par notre .gitignore donc ne le pousser pas merci par avance) à la racine de notre dépôt et y placer ceci `TENOR_KEY="Votre token tenor"`. Si vous n'avez pas de token tenor il vous suffit de vous [inscrire](https://tenor.com/developer/keyregistration) afin de l'obtenir.
* Créer un fichier `releasekey.properties` avec trois variables en son sein comme il suit :
```properties
KEY_FILE=releaseKey.jks
KEY_PASSWORD=MotDePasseALaCon
KEY_ALIAS=releaseKey
```
* Et également vous créer une clé si vous souhaitez produire une release soit :
* Si vous êtes sous Unix/Mac : en utilisant un script dédié à cet effet comme il suit `sh ./genKey.sh releaseKey.jks releaseKey MotDePasse "Scrum Mouton" "DnDGenerator" "The RAAD Team" "Nantes" "Pays de la Loire" "FR"`.
* Si vous êtes sur Windows nous n'avons pas travaillé sur cette plateforme et nous incitons donc à lire la [documentation](https://developer.android.com/studio/publish/app-signing#generate-key).
## tl;dr
Une app qui génère des fiches de D&D avec un GIF associé et un système de favoris.
Attention pour pouvoir exploiter pleinement notre dépôt nous vous conseillons soit d'exploité l'un des fichiers .apk provenant des releases ou des pipelines de master, cependant si vous souhaiter développer ou faire avancer notre projet, il vous faudra créer un fichier nommé `apikey.properties` (Qui est ignoré par notre .gitignore donc ne le pousser pas merci par avance) à la racine de notre dépôt et y placer ceci `TENOR_KEY="Votre token tenor"`. Si vous n'avez pas de token tenor il vous suffit de vous [inscrire](https://tenor.com/developer/keyregistration) afin de l'obtenir.
## Authors
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment