Skip to content

Instantly share code, notes, and snippets.

@susanBuck
Last active February 12, 2019 00:11
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save susanBuck/4a97e3dfb5e99b4b3feae3536b780c16 to your computer and use it in GitHub Desktop.
Save susanBuck/4a97e3dfb5e99b4b3feae3536b780c16 to your computer and use it in GitHub Desktop.
Project 2 README.md template

Any instructions/notes in italics should be removed from the template before submitting

Project 2

Outside resources

Your list of outside resources go here

3 Unique inputs

You don't have to list all inputs, just 3 unique ones. The following is an example of what I'd put if my project was the xkcd Password Generator:

  1. Text input to indicate number of words in password
  2. Checkbox to indicate whether to include a number
  3. Dropdown to indicate what symbol to include

Class

List the name of the class(es) you're using, e.g. Form.php, Password.php, etc.

Code style divergences

List any divergences from PSR-1/PSR-2 and course guidelines on code style

Notes for instructor

Any notes for me to refer to while grading; if none, omit this section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment