Add illustration in documentation

This commit is contained in:
Mylloon 2021-12-01 21:10:58 +01:00
parent 44ed096f16
commit b8a4b91b9f
13 changed files with 99 additions and 8 deletions

1
.gitattributes vendored
View file

@ -1,2 +1,3 @@
*.pdf filter=lfs diff=lfs merge=lfs -text
*.gif filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text

1
.gitignore vendored
View file

@ -7,3 +7,4 @@ documentation/*
!documentation/documentation.pdf
!documentation/documentation.tex
!documentation/img

BIN
documentation/documentation.pdf (Stored with Git LFS)

Binary file not shown.

View file

@ -1,9 +1,9 @@
\documentclass{article}
\usepackage[french]{babel} % français
\usepackage[T1]{fontenc} % encodage
\usepackage[hidelinks]{hyperref} % liens cliquable dans la table des matières
\usepackage{graphicx} % images
\usepackage{subfigure} % deux images côte à côte
\usepackage{listingsutf8} % intégration code
\usepackage{xcolor} % couleurs personnalisés
\usepackage{geometry} % change les dimensions de la page
@ -98,6 +98,8 @@
escapebegin=\color{ipython_green},
}
\renewcommand{\contentsname}{Table des matières} % traduction en FR
\title{\href{https://git.kennel.ml/Anri/GesMag}{Projet final Tkinter}}
\author{Anri Kennel\thanks{Numéro d'étudiant : 20010664}\, (L2-A)\\Module Programmation dinterfaces $\cdot$ Paris 8}
\date{Année universitaire 2021-2022}
@ -136,6 +138,13 @@
\subsection{Cahier des charges}
\begin{todolist}
\item[\fait] Page de login \texttt{/1.5}
\begin{figure}[!ht]
\centering
\includegraphics[height=0.4\textheight]{img/login.png}
\caption{Page de login}
\end{figure}
\begin{todolist}
\item[\fait] Nom d'utilisateur ne contient que des lettres et des chiffres
\item[\fait] Mot de passe de minimum 8 caractères dont 1 caractère spécial, une majuscule et une minuscule \textbf{$\Rightarrow$ possibilité d'afficher ou non le mot de passe en clair}
@ -143,23 +152,80 @@
\item[\fait] Un bouton pour quitter l'application
\end{todolist}
\item[\fait] Page de manager (définit par un nom d'utilisateur et un mot de passe) \texttt{/7.5}
\begin{figure}[!ht]
\centering
\includegraphics[height=0.3\textheight]{img/manager.png}
\caption{Page du Manager}
\end{figure}
\begin{todolist}
\item[\faitDifferemment] Peut ajouter et supprimer un caissier \textbf{$\Rightarrow$ lisiblité accru pour les champs mal renseignés, l'ID n'est pas à renseigné car assigné automatiquent par la base de donnée}
\begin{figure}[!ht]
\centering
\begin{minipage}{.5\textwidth}
\centering
\includegraphics[height=0.12\textheight]{img/add_cashier.png}
\caption{Ajout d'un caissier}
\end{minipage}%
\begin{minipage}{.5\textwidth}
\centering
\includegraphics[height=0.15\textheight]{img/remove_cashier.png}
\caption{Suppression d'un caissier}
\end{minipage}
\end{figure}
\item[\faitDifferemment] Peut voir la liste des caissiers \textbf{$\Rightarrow$ possibilité d'ouvrir des informations étendues sur un utilisateur, ainsi que de filtrer les utilisateurs (manager et caissiers) mais impossible de tout déselectionner (caissier par défaut)}
\newpage
\item[\fait] Un histogramme présentant l'évolution des sommes totales des ventes journalières de la semaine passée d'un utilisateur \textbf{$\Rightarrow$ accessible au double-clique dans la fenêtre des informations étendues d'un utilisateur}
\begin{figure}[!ht]
\centering
\includegraphics[height=0.3\textheight]{img/user_info.png}
\caption{Informations étendues sur un utilisateur}
\end{figure}
\item[\fait] Un bouton pour vider tous les champs de saisie
\item[\faitDifferemment] Un bouton pour quitter l'application \textbf{$\Rightarrow$ j'ai préféré mettre un bouton pour se déconnecter}
\item[\fait] Un bouton pour se mettre en "mode caissier"
\end{todolist}
\item[\fait] Page de caissier (définit par un identifiant, un nom d'utilisateur, un mot de passe, un nom, un prenom, une date de naissance, une adresse et un code postal) \texttt{/6}
\begin{figure}[!ht]
\hfill
\subfigure[En tant que Caissier]{\includegraphics[height=0.2\textheight]{img/cashier.png}}
\hfill
\subfigure[En tant que Manager]{\includegraphics[height=0.2\textheight]{img/cashier_as_manager.png}}
\hfill
\caption{Page du Caissier}
\end{figure}
\begin{todolist}
\item[\fait] Afficher le stock disponible
\begin{todolist}
\item[\faitDifferemment] 4 rayons de chacun au moins 10 articles de votre choix (fruits/légumes, boulangerie, boucherie/poissonnerie ou produits d'entretien) \textbf{$\Rightarrow$ toutes les images sont aux dimensions 50x50 et ont étés converties avec le logiciel Gimp}
\item[\faitDifferemment] 4 rayons de chacun au moins 10 articles de votre choix (fruits/légumes, boulangerie, \\boucherie/poissonnerie ou produits d'entretien) \textbf{$\Rightarrow$ toutes les images sont aux dimensions 50x50 et ont étés converties avec le logiciel Gimp}
\item[\faitDifferemment] Au clic sur le produit, l'identifiant, le nom, la quantité en stock et le prix s'affichent \textbf{$\Rightarrow$ tout est affiché directement, pas besoin de cliquer sur le produit, il y a aussi un système de pages pour une meilleur lisibilité (10 éléments par page au maximum)}
\end{todolist}
\newpage
\item[\fait] Possibilité de rajouter des produits en stock
\begin{figure}[!ht]
\centering
\includegraphics[height=0.3\textheight]{img/add_stock.png}
\caption{Ajout d'éléments au stock}
\end{figure}
\item[\fait] Affichage d'un ticket de caisse
\begin{figure}[!ht]
\centering
\includegraphics[height=0.3\textheight]{img/receipt.png}
\caption{Ticket de caisse avec 2 éléments au panier}
\end{figure}
\begin{todolist}
\item[\fait] Date de vente
\item[\fait] ID, nom, quantité, prix des produits achetés
@ -184,10 +250,6 @@
\item[\faitDifferemment] Ajout d'autres fonctionnalités \texttt{/1}
\begin{todolist}
\item[\faitDifferemment] J'ai pas vraiment ajouter une toute nouvelle fonctionnalité, mais améliorer ce qui était demandé pour une plus grande souplesse à l'utilisation (cf. les cases cochés avec des \ding{56})
% \item Heure de connexion stricte pour les caissiers
% \item Meilleur caissier (avec le plus de ventes sur la journée/semaine précédente par exemple)
% \item Exporter le ticket de caisse en format image
% \item Chiffrer les mots de passes dans la base de donnée
\end{todolist}
\item[\faitDifferemment] Lisibilité du code
\begin{todolist}

BIN
documentation/img/add_cashier.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/add_stock.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/cashier.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/cashier_as_manager.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/login.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/manager.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/receipt.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/remove_cashier.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
documentation/img/user_info.png (Stored with Git LFS) Normal file

Binary file not shown.