diff --git a/Doc/Design/MG/MG.pdf b/Doc/Design/MG/MG.pdf index 3903f4fe3a724c93893e1d14ecdfc93475da9ebb..ce52dad25936f0cdc89ab2adae266fa2bebade8d 100644 Binary files a/Doc/Design/MG/MG.pdf and b/Doc/Design/MG/MG.pdf differ diff --git a/Doc/Design/MG/MG.tex b/Doc/Design/MG/MG.tex index e159478cc07f20822a61a75ddc97e58f514c0cc9..2929d6c8e04ff5cb8b9bdc4ad109f7721cea89e1 100644 --- a/Doc/Design/MG/MG.tex +++ b/Doc/Design/MG/MG.tex @@ -90,7 +90,7 @@ Our design follows the rules laid out by \citet{ParnasEtAl1984}, as follows: Gifitti is a software solution for allowing users with a varying knowledge base on image manipulation, as well as technical experience with computers to be able to load, decompose, and modify GIF images. \\ -The following document outlines the Module Guide for Gifitti ahdhering to the document +The following document outlines the Module Guide for Gifitti adhering to the document description above. After completing the first stage of the design, the Software Requirements diff --git a/Doc/Design/MIS/MIS.pdf b/Doc/Design/MIS/MIS.pdf index 9485fe9b1e2c324546cc84d30e212bba506e78d3..ff5e86484b4f3af5ac549cab3dd0e1ce635e8220 100644 Binary files a/Doc/Design/MIS/MIS.pdf and b/Doc/Design/MIS/MIS.pdf differ diff --git a/Doc/Design/MIS/MIS.tex b/Doc/Design/MIS/MIS.tex index 20d3729b7643d84078d1e7d40d93b0f26b814faa..62cce7d7b4e1837087a36f80130de01a7d430b46 100644 --- a/Doc/Design/MIS/MIS.tex +++ b/Doc/Design/MIS/MIS.tex @@ -105,7 +105,7 @@ This module allows for the conversion of system paths to images in a usable form \end{enumerate} \subsubsection{Methods} \begin{enumerate} - \item LoadImage(string FilePath) \\This method takes as input the filepath and converts + \item LoadImage(string FilePath) \\This method takes as input the file path and converts it to an image file type using M4. This image is saved in the Image variable. \item frameConstruction(Image img) \\Decomposes GIF into its frames. \end{enumerate} @@ -136,7 +136,7 @@ This module converts the GIF from a GIF Model (M8) to an image exportable by the \end{enumerate} \subsection{GIF Transformation Module} -This module handles frame by frame manipulation of the GIF Models (M8) in order to complete operations such as resizing and modifyng the speed, etc. All +This module handles frame by frame manipulation of the GIF Models (M8) in order to complete operations such as resizing and modifying the speed, etc. All the methods and variables of this module are listed below. \subsubsection{Variables} \begin{enumerate} diff --git a/Doc/DevelopmentPlan/DevelopmentPlan.pdf b/Doc/DevelopmentPlan/DevelopmentPlan.pdf index 3eaee0d681a07a545acd75017ff4ec250a73fe3f..25fd32d21dd18c8e52320c4d9b06477de303153a 100644 Binary files a/Doc/DevelopmentPlan/DevelopmentPlan.pdf and b/Doc/DevelopmentPlan/DevelopmentPlan.pdf differ diff --git a/Doc/DevelopmentPlan/DevelopmentPlan.tex b/Doc/DevelopmentPlan/DevelopmentPlan.tex index 333a000d0da3d43e8c080051e5c205975229efd7..ec197e2e16acb2706e7a62ae353c0e3ae1e196bf 100644 --- a/Doc/DevelopmentPlan/DevelopmentPlan.tex +++ b/Doc/DevelopmentPlan/DevelopmentPlan.tex @@ -52,7 +52,7 @@ Skype will be the primary method to conduct calls for team meetings when physica meeting is infeasible. To contact a T.A. or Professor due to questions or issues with the project, McMaster e-mail will be used. -\section{Team Member Roles} Nick will be in charge of the proejct and is designated as the Team Leader. +\section{Team Member Roles} Nick will be in charge of the project and is designated as the Team Leader. His job is to assign tasks and provide a clear goal on what needs to be completed. He is knowledgeable on Gantt charts, GIT, image manipulation and C\#. Riley will be responsible for scribing the team meetings and is experienced with @@ -106,7 +106,7 @@ Deliverables will be considered major updates to the project. \end{itemize} \subsubsection*{Risk 1} The first risk will be reading in GIFs. GIF files must be read into Gifitti and parsed. -\subsubsection*{Plan to demonstrate risk 1's feasibility} An open source lirary that provides this functionality must be chosen +\subsubsection*{Plan to demonstrate risk 1's feasibility} An open source library that provides this functionality must be chosen and implemented into a base design by the project demo's deadline. This will be reflected on the Gantt chart. \subsubsection*{Risk 2} The project will only be usable on a Windows platform, until @@ -133,7 +133,7 @@ unit testing. This platform comes integrated with Visual Studio 2015 Community. documentation. \item Visual Studio will be used for any post code software model generation \item Gantt Project will be used to document the project schedule \end{itemize} -\section{Coding Style} The coding standard tha will be utilized for this project is the +\section{Coding Style} The coding standard that will be utilized for this project is the \href{https://msdn.microsoft.com/en-us/library/hh156542(v=vs.110).aspx}{.NET Framework Development Guide}. @@ -142,6 +142,6 @@ be found \href{https://gitlab.cas.mcmaster.ca/kozeln/Gifitti/tree/master/ProjectSchedule}{here.} \section{Project Review} -After completing Gifitti, we feel that our development plan worked well and aided in the successful completion of this project. Our GIT workflow plan was very helpful and reduced the amount of troubleshooting needed to fix merges or repository errors. Our master branch was clean throughout the entire development phase and as features were added and merged into master, it remained stable. We felt very comfortable within our team member roles and all performed within those roles to the best of our abilities. Our roles matched our personalities and we feel this made a big impact on everyone's motivation and attitude towards the project. The things that we felt did not work for us were the team meeting schedule and the coding style guidelines. We learned that because of time constraints or laziness, we did not adher to the coding guidelines all the time and we each had our own styles of coding regardless of the guidelines. The team meetings were effective but we did not have them as often as we said we would. This was due to the nature of everyones schedules and the fact that we did not want to meet on the weekends. Therefore, on a future project the only things that we would change would be to meet on dedicated days where we know everyone is available and choose less strict coding guidelines or have repercussions for not following them. +After completing Gifitti, we feel that our development plan worked well and aided in the successful completion of this project. Our GIT workflow plan was very helpful and reduced the amount of troubleshooting needed to fix merges or repository errors. Our master branch was clean throughout the entire development phase and as features were added and merged into master, it remained stable. We felt very comfortable within our team member roles and all performed within those roles to the best of our abilities. Our roles matched our personalities and we feel this made a big impact on everyone's motivation and attitude towards the project. The things that we felt did not work for us were the team meeting schedule and the coding style guidelines. We learned that because of time constraints or laziness, we did not adhere to the coding guidelines all the time and we each had our own styles of coding regardless of the guidelines. The team meetings were effective but we did not have them as often as we said we would. This was due to the nature of everyone's schedules and the fact that we did not want to meet on the weekends. Therefore, on a future project the only things that we would change would be to meet on dedicated days where we know everyone is available and choose less strict coding guidelines or have repercussions for not following them. \end{document} \ No newline at end of file diff --git a/Doc/TestPlan/TestPlan.pdf b/Doc/TestPlan/TestPlan.pdf index c995f4ce1feb4264ef7cc329a7a8c3784664561b..8900c6cfa651612eea3ae80f11fbc749830300a1 100644 Binary files a/Doc/TestPlan/TestPlan.pdf and b/Doc/TestPlan/TestPlan.pdf differ diff --git a/Doc/TestPlan/TestPlan.tex b/Doc/TestPlan/TestPlan.tex index 0bc9bb5be246aaae73a1a3c8f952db0da7bc2630..435bc6d5586f3c1e5cede4a79cb3399a303df7f1 100644 --- a/Doc/TestPlan/TestPlan.tex +++ b/Doc/TestPlan/TestPlan.tex @@ -412,7 +412,7 @@ How test will be performed: \item{Click Resize} \item{Enter a width and height value} \item{Choose save as and specify a file path.} -\item{Verify the GIF was exported sucessfully and resized accordingly.} +\item{Verify the GIF was exported successfully and resized accordingly.} \\ \end{enumerate} \item{resizing-id2\\} @@ -469,7 +469,7 @@ Input: GIF. Output: NA -How test will be performed: Load a GIF into the program. The time to load the GIF and start playback should be less than MAX\_UI\_LOAD. MAX\_UI\_LOAD is derived from the original system, GIF Viewer, so make sure this test is perfromed on the same system as the benchmark MAX\_UI\_LOAD is acquired from. +How test will be performed: Load a GIF into the program. The time to load the GIF and start playback should be less than MAX\_UI\_LOAD. MAX\_UI\_LOAD is derived from the original system, GIF Viewer, so make sure this test is performed on the same system as the benchmark MAX\_UI\_LOAD is acquired from. \end{enumerate} @@ -608,7 +608,7 @@ To test the validity of outputted GIF images, the testing system will hold image %\bibliographystyle{plainnat} \section{Bibliography} -Microsoft Visual Studio Unit Testing Framework, Microsoft Incorperated; \\\href{https://msdn.microsoft.com/en-us/library/dd264975.aspx}{https://msdn.microsoft.com/en-us/library/dd264975.aspx} \\\\ +Microsoft Visual Studio Unit Testing Framework, Microsoft Incorporated; \\\href{https://msdn.microsoft.com/en-us/library/dd264975.aspx}{https://msdn.microsoft.com/en-us/library/dd264975.aspx} \\\\ Questionnaire Template, Chin, J.P., Diehl, V.A., Norman, K.L.; \\\href{http://garyperlman.com/quest/quest.cgi?form=QUIS}{ http://garyperlman.com/quest/quest.cgi?form=QUIS} \newpage