diff --git a/Doc/DevelopmentPlan/DevelopmentPlan.pdf b/Doc/DevelopmentPlan/DevelopmentPlan.pdf index aaf2c97d088dde71c7527b11d96174fcab3d7556..403545e21151f6ccdf333345b0e5dc34f087f442 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 f17a2464f6e3ddbcf1eca57aa8d7a98a60f35472..0e142c69b1f69b485816760fa6b057c27786bacf 100644 --- a/Doc/DevelopmentPlan/DevelopmentPlan.tex +++ b/Doc/DevelopmentPlan/DevelopmentPlan.tex @@ -4,6 +4,7 @@ \usepackage{tabularx} \usepackage{indentfirst} \usepackage{hyperref} +\usepackage{color} \title{SE 3XA3: Development Plan\\Rogue Reborn} @@ -44,12 +45,12 @@ \maketitle +\textcolor{red}{This text can be in a \textit{Abstract} section - CM} \\ \indent The Rogue Reborn project aims to rewrite the classic video game \textit{Rogue} in a modern programming language using contemporary software development techniques. The purpose of this document is to outline the development plan of the project. Included below are the strategies for \hyperref[communication_label]{team coordination} and \hyperref[roles_label]{work partitioning}, details of the \hyperref[tech_label]{technology} and \hyperref[workflow_label]{development process}, and an overview of the \hyperref[schedule_label]{project schedule} including details of the requirements for the \hyperref[poc_label]{proof of concept} deadline. \section{Team Meeting Plan} \label{meeting_label} - \indent Team meetings will be held on a weekly basis in Thode library at 3:30 PM every Wednesday. These weekly meetings will be chaired by the team leader whose will be responsible for developing and enforcing a rough meeting agenda. Although this agenda will not be posted, it will be briefly outlined for the participants of the meeting. In addition, full meeting minutes will not be recorded; however, the meeting scribe will be responsible for recording the outcomes of the meeting discussions. These transcripts will be posted to the team Git repository. If a team member cannot attend the meeting, a brief summary of the meeting (including a reference to the Git commit) will be posted to the team Slack channel by the meeting scribe. Any changes to the meeting format, location, or time will also be posted to the team Slack channel by the meeting chair. @@ -101,7 +102,7 @@ With respect to the environment of the technology, the Rogue++ team agreed to us \section{Coding Style} \label{style_label} - +\textcolor{red}{Consider colouring hyperlinks to aid reader - CM} \\ \indent In any large-scale project, it is vital for all members to be on the same page. This is especially true for a software project, where every team member must be able to read, understand, and analyze everyone else's code. The Rogue++ project will be utilizing \href{https://google.github.io/styleguide/cppguide.html}{Google's C++ Style Guide} to format and organize the source code. Google offers style guides that span dozens of programming languages and are a professional standard used in every corner of the software industry. Despite its excellence, the team will implement one change to the guide.\\ @@ -115,4 +116,5 @@ The project schedule is found at \href{run:../../ProjectSchedule/Rogue.gan}{this \section{Project Review} +\textcolor{red}{Fantastic development plan, do not think the lack of comments is from a lack of effort to make them but rather the lack of anything wrong. Keep this up, I am very impressed and excited to see how this project pans out. - CM} \\ \end{document} \ No newline at end of file