Procházet zdrojové kódy

ajout readme complet2

PCYoshi před 9 roky
rodič
revize
f948e99ffa
2 změnil soubory, kde provedl 56 přidání a 70 odebrání
  1. 10
    70
      java/.idea/workspace.xml
  2. 46
    0
      java/README.md

+ 10
- 70
java/.idea/workspace.xml Zobrazit soubor

@@ -7,73 +7,7 @@
7 7
   </component>
8 8
   <component name="ChangeListManager">
9 9
     <list default="true" id="a647cb6a-4230-4101-a652-d7cfd0c21e24" name="Default" comment="">
10
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/out/production/java/GestionBddDAO/ConfigBDD.class" afterPath="$PROJECT_DIR$/out/production/java/GestionBddDAO/ConfigBDD.class" />
11
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/out/artifacts/java_jar/java.jar" afterPath="$PROJECT_DIR$/out/artifacts/java_jar/java.jar" />
12
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionErreurs/BDDException.html" afterPath="$PROJECT_DIR$/javadoc/GestionErreurs/BDDException.html" />
13
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/Bouton.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/Bouton.html" />
14
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/Categorie.html" afterPath="$PROJECT_DIR$/javadoc/Modele/Categorie.html" />
15
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/ConfigBDD.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/ConfigBDD.html" />
16
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/ConnexionBDD.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/ConnexionBDD.html" />
17
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/ConnexionBddDialog.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/ConnexionBddDialog.html" />
18
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionCategories.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionCategories.html" />
19
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionQuestions.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionQuestions.html" />
20
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionReponses.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/GestionReponses.html" />
21
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanCategoriesListener.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanCategoriesListener.html" />
22
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanQuestionsListener.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanQuestionsListener.html" />
23
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanReponsesListener.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.PanReponsesListener.html" />
24
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/InterfacePrincipale.html" />
25
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/MainAdminBddBurgerQuizz.html" afterPath="$PROJECT_DIR$/javadoc/MainAdminBddBurgerQuizz.html" />
26
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/NouvelleQuestionDialog.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/NouvelleQuestionDialog.html" />
27
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/NouvelleReponseDialog.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/NouvelleReponseDialog.html" />
28
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/Question.html" afterPath="$PROJECT_DIR$/javadoc/Modele/Question.html" />
29
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/Reponses.html" afterPath="$PROJECT_DIR$/javadoc/Modele/Reponses.html" />
30
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/SplashScreen.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/SplashScreen.html" />
31
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/allclasses-frame.html" afterPath="$PROJECT_DIR$/javadoc/allclasses-frame.html" />
32
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/allclasses-noframe.html" afterPath="$PROJECT_DIR$/javadoc/allclasses-noframe.html" />
33
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/constant-values.html" afterPath="$PROJECT_DIR$/javadoc/constant-values.html" />
34
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/deprecated-list.html" afterPath="$PROJECT_DIR$/javadoc/deprecated-list.html" />
35
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/help-doc.html" afterPath="$PROJECT_DIR$/javadoc/help-doc.html" />
36
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-1.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-1.html" />
37
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-10.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-10.html" />
38
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-11.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-11.html" />
39
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-12.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-12.html" />
40
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-13.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-13.html" />
41
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-14.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-14.html" />
42
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-15.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-15.html" />
43
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-16.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-16.html" />
44
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-17.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-17.html" />
45
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-18.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-18.html" />
46
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-2.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-2.html" />
47
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-3.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-3.html" />
48
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-4.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-4.html" />
49
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-5.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-5.html" />
50
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-6.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-6.html" />
51
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-7.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-7.html" />
52
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-8.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-8.html" />
53
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index-files/index-9.html" afterPath="$PROJECT_DIR$/javadoc/index-files/index-9.html" />
54
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/index.html" afterPath="$PROJECT_DIR$/javadoc/index.html" />
55
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/overview-frame.html" afterPath="$PROJECT_DIR$/javadoc/overview-frame.html" />
56
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/overview-summary.html" afterPath="$PROJECT_DIR$/javadoc/overview-summary.html" />
57
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/overview-tree.html" afterPath="$PROJECT_DIR$/javadoc/overview-tree.html" />
58
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/package-frame.html" />
59
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-frame.html" />
60
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionErreurs/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/GestionErreurs/package-frame.html" />
61
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-frame.html" />
62
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-frame.html" />
63
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/package-frame.html" afterPath="$PROJECT_DIR$/javadoc/Modele/package-frame.html" />
64
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/package-summary.html" />
65
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-summary.html" />
66
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionErreurs/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/GestionErreurs/package-summary.html" />
67
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-summary.html" />
68
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-summary.html" />
69
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/package-summary.html" afterPath="$PROJECT_DIR$/javadoc/Modele/package-summary.html" />
70
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/package-tree.html" />
71
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/GestionBddDAO/package-tree.html" />
72
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/GestionErreurs/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/GestionErreurs/package-tree.html" />
73
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/package-tree.html" />
74
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/InterfaceGraphique/DialogBoxes/package-tree.html" />
75
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/Modele/package-tree.html" afterPath="$PROJECT_DIR$/javadoc/Modele/package-tree.html" />
76
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/javadoc/serialized-form.html" afterPath="$PROJECT_DIR$/javadoc/serialized-form.html" />
10
+      <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/README.md" />
77 11
       <change type="MODIFICATION" beforePath="$PROJECT_DIR$/.idea/workspace.xml" afterPath="$PROJECT_DIR$/.idea/workspace.xml" />
78 12
     </list>
79 13
     <ignored path="java.iws" />
@@ -962,7 +896,13 @@
962 896
       <option name="project" value="LOCAL" />
963 897
       <updated>1434009313049</updated>
964 898
     </task>
965
-    <option name="localTasksCounter" value="36" />
899
+    <task id="LOCAL-00036" summary="ajout readme complet">
900
+      <created>1434011190513</created>
901
+      <option name="number" value="00036" />
902
+      <option name="project" value="LOCAL" />
903
+      <updated>1434011190513</updated>
904
+    </task>
905
+    <option name="localTasksCounter" value="37" />
966 906
     <servers />
967 907
   </component>
968 908
   <component name="TodoView">
@@ -1015,7 +955,6 @@
1015 955
     <option name="myLimit" value="2678400000" />
1016 956
   </component>
1017 957
   <component name="VcsManagerConfiguration">
1018
-    <MESSAGE value="fin de journé" />
1019 958
     <MESSAGE value="nyan cat operationel + look n felle susteme ajouté + chgm couleur" />
1020 959
     <MESSAGE value="les boutons ecoutent" />
1021 960
     <MESSAGE value="conexion bdd operationelle et avance classe de base" />
@@ -1040,7 +979,8 @@
1040 979
     <MESSAGE value="avancées javadoc6" />
1041 980
     <MESSAGE value="avancées javadoc7" />
1042 981
     <MESSAGE value="ajout readme" />
1043
-    <option name="LAST_COMMIT_MESSAGE" value="ajout readme" />
982
+    <MESSAGE value="ajout readme complet" />
983
+    <option name="LAST_COMMIT_MESSAGE" value="ajout readme complet" />
1044 984
   </component>
1045 985
   <component name="XDebuggerManager">
1046 986
     <breakpoint-manager>

+ 46
- 0
java/README.md Zobrazit soubor

@@ -0,0 +1,46 @@
1
+Burger Quizz: Interface Administrateur JAVA
2
+===========================================
3
+
4
+Créé dans le cadre du projet de fin d'année de la promo 2018 de CIR2 de l'ISEN Brest/Rennes, le Burger Quizz est une adaptation numérique du jeu télévisé éponyme, plus précisément d'une épreuve spécifique de ce jeu : le "Sel ou Poivre".
5
+
6
+Dans cette épreuve de rapidité, les joueurs sont confrontés à des jeux de questions correspondant à plusieurs thèmes sur différentes catégories. Pour plus d'informations, consulter la rubrique "Règles" du site une fois ce dernier installé.
7
+
8
+Cette application est composée d'une application Web en PHP et Javascript, ainsi que d'une application Java permettant d'administrer la base de questions.
9
+
10
+Structure du dossier
11
+--------------------
12
+
13
+* `conf.xml` contient la configuration de la connexion à la base de données. Peut être modifié "à la main", ou depuis l'application. S'il n'existe pas, l'application le créé et le remplis avec une configuration par défaut.
14
+* `lib` contient le .jar jdbc de connexion à mysql.
15
+* `rsc` contient les ressources graphiques.
16
+* `src` contient les sources de l'application.
17
+* `BGAdmin.jar` le jar executable.
18
+
19
+Execution depuis le jar
20
+-----------------------
21
+
22
+Le jar executable contient le driver jdbc. Pour l'executer:
23
+`java -jar BGAdmin.jar`
24
+
25
+Compilation et execution depuis les sources
26
+-------------------------------------------
27
+
28
+###Compilation depuis les sources
29
+
30
+0. Avoir un JDK Java installé
31
+1. Allez dans le repertoire `src`
32
+2. Y copier le fichier `lib/mysql-connector-java-5.1.35-bin.jar`
33
+3. Lancer la commande `javac -cp mysql-connector-java-5.1.35-bin.jar:. MainAdminBddBurgerQuizz.java`
34
+
35
+###Execution depuis les sources compilées
36
+
37
+0. Avoir un JRE Java installé
38
+1. Allez dans le repertoire `src`
39
+3. Y copier le dossier `rsc`
40
+4. Lancer `java -cp mysql-connector-java-5.1.35-bin.jar:. MainAdminBddBurgerQuizz`
41
+
42
+Génération de la Javadoc
43
+------------------------
44
+0. Avoir un JDK Java installé
45
+1. Allez dans le repertoire `src`
46
+2. Lancer la commande `javadoc -private -d ./REPERTOIRE_OU_STOCKER_LA_DOCUMENTATION -sourcepath . -subpackages GestionBddDAO InterfaceGraphique InterfaceGraphique.DialogBoxes GestionErreurs Modele MainAdminBddBurgerQuizz.java -encoding "utf8" -docencoding "utf8" -charset utf8`