Merge pull request #58 from zwrawr/release/submitted

Updated to VS17 and did some clean up of the readme

DSA_Assessment/DSA_Assessment.vcxproj

@@ -281,6 +281,9 @@
       <DeploymentContent>true</DeploymentContent>
     </Text>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.md" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

DSA_Assessment/DSA_Assessment.vcxproj.filters

@@ -110,4 +110,7 @@
       <Filter>Resource Files</Filter>
     </Text>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.md" />
+  </ItemGroup>
 </Project>

README.md

@@ -1,6 +1,10 @@
-# The task
-> #Data Structures and Algorithms Assessment
-> ## Task: Predictive Text
+# Data Structures and Algorithms Assessment
+
+*tldr; Created a cli predictive text system and achived a mark of 84%*
+## Task: Predictive Text
+
+Here is the [*pdf*](http://www.elec.york.ac.uk/internal_web/meng/yr2/modules/DSA/DSA/Assessment/DSAAssessment2016.pdf) that outlines the assessment. It's unlikely that you'll be able to view this files so here is the basic outline of the assessment 
+
 > You are to design and implement a program that can perform a predictive text function similar to
 that employed in modern mobile phones.
 
@@ -20,31 +24,38 @@ solution. Programs that choose appropriate data structures and algorithms that m
 text system efficient will receive higher marks. Consideration of how to enable punctuation and
 capitalisation will also be welcomed.
 
-> ## Marking Guidelines
+## Marking Guidelines
 The marks are broken down into the following categories:
 
-> ### Choice of Data Structure (6)  
-Space complexity (with respect to size of dictionary) 2  
-Time complexity (with respect to size of dictionary) 2  
-Simplicity of data structure 2  
-
-> ### Program Implementation (20)  
-Representational independence (interface and implementation separation) 3  
-Modularity of program (at least three program files with appropriate contents) 2  
-Functional modularity (program broken up into an appropriate series of functions) 3  
-Program documentation (commenting, formatting, suitable names of variables etc) 2  
-Clarity and simplicity of program (good program structure, logical flow) 3  
-Execution (how well does the actual program work) 3  
-Completeness (how complete is the submitted program, how functional) 2  
-User interface 2  
-
-> ### Report (24)  
-Explanation of program 8  
-Explanation of data structure chosen and discussion of alternatives 10  
-Readability and formatting 4  
-Testing strategy (how did you test your design?) 2  
-
-[*Assesment pdf*](http://www.elec.york.ac.uk/internal_web/meng/yr2/modules/DSA/DSA/Assessment/DSAAssessment2016.pdf)
-
-# My report 
-[pdf of the report](https://github.com/zwrawr/DSA_Assessment/blob/master/Report/DSA_AssesmentReport.pdf)
+### Choice of Data Structure (6)  
+* Space complexity (with respect to size of dictionary) 2  
+* Time complexity (with respect to size of dictionary) 2  
+* Simplicity of data structure 2  
+
+### Program Implementation (20)  
+* Representational independence (interface and implementation separation) 3  
+* Modularity of program (at least three program files with appropriate contents) 2  
+* Functional modularity (program broken up into an appropriate series of functions) 3  
+* Program documentation (commenting, formatting, suitable names of variables etc) 2  
+* Clarity and simplicity of program (good program structure, logical flow) 3  
+* Execution (how well does the actual program work) 3  
+* Completeness (how complete is the submitted program, how functional) 2  
+* User interface 2  
+
+### Report (24)  
+* Explanation of program 8  
+* Explanation of data structure chosen and discussion of alternatives 10  
+* Readability and formatting 4  
+*Testing strategy (how did you test your design?) 2  
+
+## My submition
+
+### Source
+The submitted source code is under the 'release/submitted' branch and is the release tagged as 'submitted'
+
+### Report 
+The [pdf of the report](https://github.com/zwrawr/DSA_Assessment/blob/master/Report/DSA_AssesmentReport.pdf) can be found here.
+
+## Results
+I obtained 84% for this assessment which is a starred first.
+