From b3c81e61a03cf97f10b88a0bfbf18a619979ad1c Mon Sep 17 00:00:00 2001 From: SIMAILA Djalim Date: Mon, 21 Nov 2022 09:58:31 +0100 Subject: [PATCH 1/3] debut de redaction du readme --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc8a017 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# PackageViewer +## A propos +PackageViewer permer de rechercher et de visualiser un paquet et les dependances du paquet pour une distribtion donnée. + +## Captures d'ecran + +TODO Meubler avec des screen + +## Utilisation +```java -jar PackageViewer -d debian neofetch``` + + +```java -jar PackageViewer -d archlinux --depth 6 xorg-server``` + +Vous pouvez trouver plus de documentation sur le +[wiki](https://google.com/) + +(TODO Changer le lien vers le wiki) + +## Build + +TODO Meubler ici pour le gradle run. + +TODO Meubler ici pour les tests. + +## Contributeurs + +[CAPELIER Marla](https://github.com/Capelier-Mathieu) + +[SIMAILA Djalim](https://github.com/DjalimSimaila) + +[RUBINI Thomas](https://github.com/ThomasRubini) + From df8e43cc2435852fd58e2a24894d5bb113c9c615 Mon Sep 17 00:00:00 2001 From: SIMAILA Djalim Date: Thu, 15 Dec 2022 14:31:15 +0100 Subject: [PATCH 2/3] completed readme --- README.md | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bc8a017..2324747 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,51 @@ # PackageViewer +![build Status](https://github.com/ThomasRubini/PackageViewer/actions/workflows/ci.yml/badge.svg) + ## A propos PackageViewer permer de rechercher et de visualiser un paquet et les dependances du paquet pour une distribtion donnée. -## Captures d'ecran +## Distribution supportées -TODO Meubler avec des screen +- Arch Linux (depots officiels) +- Fedora ## Utilisation -```java -jar PackageViewer -d debian neofetch``` + +Pour utiliser notre projet vous pouvez cloner et build notre projet ou bien recuperer la [derniere build](https://nightly.link/ThomasRubini/PackageViewer/workflows/ci/main/PackageViewer%20jar.zip). + +```java -jar PackageViewer.jar -d fedora neofetch``` -```java -jar PackageViewer -d archlinux --depth 6 xorg-server``` - -Vous pouvez trouver plus de documentation sur le -[wiki](https://google.com/) - -(TODO Changer le lien vers le wiki) +```java -jar PackageViewer.jar -d arch --depth 6 xorg-server``` ## Build -TODO Meubler ici pour le gradle run. +Pour build le projet il faut necessairement une version de java superieure a 15. -TODO Meubler ici pour les tests. +Pour créer le fichier jar de notre projet il suffit de lancer la task "jar" du projet gradle : + +```./gradlew jar``` + +Vous pouvez lancer les test en lançant la task "test" : + +```./gradlew test``` + +Dans le cas ou vous n'avez jamais utilisé gradle, l'executable ```gradlew``` se trouve a la racine du depot. + +## F.A.Q + +Q: Est ce qu'il me faut internet pour utiliser ce programme? +R: Oui, il fonctionne en faisant des requetes vers des api, sans connection c'est un peu plus compliqué. + +Q: Est ce que {votre distribution preferée} sera supportée dans le futur? +R: Si elle fournit une api pour ses paquets, peut etre. Sinon non :). + +Q: Est ce que je peux l'utiliser sur ma Nintendo Switch? +R: Oui, la version d'ubuntu que switchroot installe a une version assez recente de java pour lancer le programme. ## Contributeurs -[CAPELIER Marla](https://github.com/Capelier-Mathieu) +[CAPELIER Marla](https://github.com/Capelier-Marla) [SIMAILA Djalim](https://github.com/DjalimSimaila) From 1687f505314c3317a2391f7452f60b925f96f6c9 Mon Sep 17 00:00:00 2001 From: SIMAILA Djalim Date: Thu, 15 Dec 2022 14:48:20 +0100 Subject: [PATCH 3/3] added parametters --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2324747..f7505f1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ![build Status](https://github.com/ThomasRubini/PackageViewer/actions/workflows/ci.yml/badge.svg) ## A propos + PackageViewer permer de rechercher et de visualiser un paquet et les dependances du paquet pour une distribtion donnée. ## Distribution supportées @@ -13,6 +14,15 @@ PackageViewer permer de rechercher et de visualiser un paquet et les dependances Pour utiliser notre projet vous pouvez cloner et build notre projet ou bien recuperer la [derniere build](https://nightly.link/ThomasRubini/PackageViewer/workflows/ci/main/PackageViewer%20jar.zip). +### parametres + +| parametre | description | +| ----------- | ------------------------------------------------ | +| --help, -h | Affiche l’aide | +| --distro,-d <{distribution}> | Distribution linux dans la quelle rechercher le paquet | +| --depth <{profondeur}> | Profondeur de l’arbre de dependance a afficher | + +### Exemples ```java -jar PackageViewer.jar -d fedora neofetch``` @@ -26,6 +36,8 @@ Pour créer le fichier jar de notre projet il suffit de lancer la task "jar" du ```./gradlew jar``` +Vous retrouverez le fichier jar dans le dossier ```build/libs/```. + Vous pouvez lancer les test en lançant la task "test" : ```./gradlew test``` @@ -50,4 +62,3 @@ R: Oui, la version d'ubuntu que switchroot installe a une version assez recente [SIMAILA Djalim](https://github.com/DjalimSimaila) [RUBINI Thomas](https://github.com/ThomasRubini) -