Arthur Brandao před 5 roky
rodič
revize
c8d050562c
3 změnil soubory, kde provedl 42 přidání a 7 odebrání
  1. 10 3
      text/src/Application.md
  2. 12 4
      text/src/Cliquez sur moi.md
  3. 20 0
      text/src/Electron.md

+ 10 - 3
text/src/Application.md

@@ -15,7 +15,9 @@ Toute la partie métier de l'application a été écrite en javascript sans fram
 
 #### Lancement
 
-Cette application peut soit être lancée dans un navigateur via un serveur HTTP (un serveur est mis à disposition avec l'application), soit directement dans electron. Il est ***impossible*** de lancer l'application directement depuis le navigateur de fichier en ouvrant le fichier index.html dans le navigateur. En effet l'application fait des requêtes GET pour charger les notes présentent par défaut, or la sécurité d'un navigateur bloque ces requêtes lors de l'exécution depuis le système de fichier.
+Cette application peut soit être lancée dans un navigateur via un serveur HTTP (un serveur est mis à disposition avec l'application), soit directement dans electron. 
+Il est ***impossible*** de lancer l'application directement depuis le navigateur de fichier en ouvrant le fichier index.html dans le navigateur. 
+En effet l'application fait des requêtes GET pour charger les notes présentent par défaut, or la sécurité d'un navigateur bloque ces requêtes lors de l'exécution depuis le système de fichier.
 
 Pour lancer l'application dans un serveur web il faut utiliser la commande suivante (le navigateur s'ouvre automatiquement sur l'URL de l'application) :
 
@@ -31,6 +33,11 @@ npm run src:electron
 
 #### Source
 
-Que l'application soit lancée sur un serveur web pour être affichée dans un navigateur ou directement dans electron, ce sont les même fichiers sources qui sont utilisés. Les fichiers sources de cette version de l'application sont disponible dans le dossier `src/` à la racine du projet.
+Que l'application soit lancée sur un serveur web pour être affichée dans un navigateur ou directement dans electron, ce sont les même fichiers sources qui sont utilisés. 
+Les fichiers sources de cette version de l'application sont disponible dans le dossier `src/` à la racine du projet.
 
-Le code javascript propre à l'application se trouve directement dans les fichiers HTML. Le dossier `css/` contient toute les feuilles de style de l'application (format scss et css) dont le fichier `style.scss` qui a été écrit pour l'application. Le dossier `js/` contient les fichiers avec les fonctions javascript utilisées. Le fichier `binder.js` (écrit pour le projet) contient des fonctions pour automatiser l'affichage de données dans le document HTML et le fichier `script.js` contient des fonctions utilitaire pour l'application. Enfin le dossier `data/` contient les données des notes présentent par défaut.
+Le code javascript propre à l'application se trouve directement dans les fichiers HTML. 
+Le dossier `css/` contient toute les feuilles de style de l'application (format scss et css) dont le fichier `style.scss` qui a été écrit pour l'application. 
+Le dossier `js/` contient les fichiers avec les fonctions javascript utilisées. 
+Le fichier `binder.js` (écrit pour le projet) contient des fonctions pour automatiser l'affichage de données dans le document HTML et le fichier `script.js` contient des fonctions utilitaire pour l'application. 
+Enfin le dossier `data/` contient les données des notes présentent par défaut.

+ 12 - 4
text/src/Cliquez sur moi.md

@@ -2,17 +2,25 @@ Ceci est une note. Elle contient des informations diverses.
 
 #### Ajouter une note
 
-Il est possible d'ajouter autant de note que vous voulez. Chaque note apparaitra sous forme de carte dans la page d'accueil. Cliquez dessus pour voir ce qu'elles contiennent. La création d'une note utilise un éditeur WYSIWYG markdown pour mettre en forme le texte.
+Il est possible d'ajouter autant de note que vous voulez. 
+Chaque note apparaitra sous forme de carte dans la page d'accueil. 
+Cliquez dessus pour voir ce qu'elles contiennent. 
+La création d'une note utilise un éditeur WYSIWYG markdown pour mettre en forme le texte.
 
 #### Modifier une note
 
-Il est aussi possible de modifier une note, pour ce faire cliquez simplement sur le bouton modifier sur la carte ou lorsque la note est affichée. Le système d'édition est le même que pour l'ajout et utilise le markdown pour mettre en forme le texte.
+Il est aussi possible de modifier une note, pour ce faire cliquez simplement sur le bouton modifier sur la carte ou lorsque la note est affichée. 
+Le système d'édition est le même que pour l'ajout et utilise le markdown pour mettre en forme le texte.
 
 #### Supprimer une note
 
-Pour supprimer une note il suffit de cliquez sur le bouton supprimer sur la carte ou dans la note. Attention il n'y a aucune demande de confirmation. Toute note est définitivement supprimé et ne peut être récupérée.
+Pour supprimer une note il suffit de cliquez sur le bouton supprimer sur la carte ou dans la note. 
+Attention il n'y a aucune demande de confirmation. 
+Toute note est définitivement supprimé et ne peut être récupérée.
 
 #### Menu
 
-Le menu en haut à droite de la page contient des liens vers le site d'electron et du git du projet. Le bouton reset permet de remettre à zero l'application. Remettre à zero l'application supprimera toutes les notes ajouté par l'utilisateur et remettra les notes par défaut dans leur état d'origine
+Le menu en haut à droite de la page contient des liens vers le site d'electron et du git du projet. 
+Le bouton reset permet de remettre à zero l'application. 
+Remettre à zero l'application supprimera toutes les notes ajouté par l'utilisateur et remettra les notes par défaut dans leur état d'origine
 

+ 20 - 0
text/src/Electron.md

@@ -0,0 +1,20 @@
+Electron permet de faire des applications avec les technologies web (HTML 5 / CSS 3 / Javascript). 
+Les applications créée avec Electron peuvent être compiler pour tous les OS existant, ce qui permet avec une seul base de code d'avoir un executable pour tous les environement.
+
+#### Source
+
+Les sources de cette application sont exactement les même que lorsque l'application est lancé sur un serveur HTTP. 
+Les fichiers utilisé sont exactement les même. Pour plus d'informations sur les dossiers sources, ce referrer à la partie `Source`  de la note application.
+
+#### Fonctionnement
+
+Lors du lancement de l'application Electron le fichier main.js est appelé. Ce fichier permet de lancer l'application sans ou avec l'intégration d'Electron. 
+Dans le cas de cette application (sans intégration d'Electron) l'application va seulement chargé la page index.html 
+dans le dossier `src/` (la création de la fenetre est gérée par des fonctions commune aux deux versions et possède donc toujours un icone). 
+Lorsque toutes les fenetres sont fermées l'application s'arrete sauf sur Mac ou il faut utiliser Cmd+Q (fonctionnement par defaut d'Electron sur Mac).
+
+#### Menu
+
+Cette version de l'application étant identique à la version web, elle n'a aucun code spécifique a Electron. 
+De ce fait aucune indication n'est donné pour générer les menus. En l'abscence d'indications Electron genere uniquement une menu d'application (en haut de l'application) par défaut et aucun menu contextuel (clic droit). 
+Le menu est anglais et contient des raccourcis souvent utilisé comme copié/collé, agrandir ou minimiser la fenetre, ...