-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy pathdocumentation
More file actions
29 lines (24 loc) · 1.08 KB
/
Copy pathdocumentation
File metadata and controls
29 lines (24 loc) · 1.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Final Documentation
## Due at final exam period:
* README.md
* Flowchart
* Code - fully commented!
* Presentation
## README.md
This is general information about your game. At a minimum, it should include:
* A description of your game (around 1 paragraph should be good)
* Citations of your sources
* Anything else the user should know about your game
* Links to any files that are not stored on GitHub, but which are relevant to my grading of your game. I will not go searching through shared files on Google Drive for your work
## Flowchart
* May be created digitaly or by hand
* Should depict how the code runs
* If you need help, see me
## Code
* Remember to comment your code
* Each function and class should have a docstring as the first line of the block of code to describe what it does. For simple functions, this docstring is likely to be adequate commenting.
## Presentation
* 3-5 minutes
* Must have visuals
* Areas to cover are: Demonstrating the game, your favorite feature/what you're most proud of, and what you figured out in the process
* Your class will have a chance to ask questions