File must be named README.md and placed in the root of your application.
Delete any of the italics comments I included in the template that explain what you should put in each section.
Use proper Markdown syntax.
All links must be clickable.
For outside resources...
Do not cite:
Course notes or examples
Official PHP.net documentation
Specific forum posts (e.g. stackoverflow) that provided information you utilized in your code
Sources for images that you did not create
Outside resources such as CSS frameworks, Google fonts, etc.
Anything else (if in doubt, cite!)
For code style divergences: Any divergences should be done so consistently and should not hinder the ability to parse or understand the code.
Examples of acceptable divergences:
I prefer to use 2 spaces instead of 4
I prefer to put opening curly brackets of functions/methods on the same line as the function declaration.
In a few cases, my PHP code extended beyond 80 characters.
Examples of unacceptable divergences:
I did not consistently indent my code
I prefer to use 2 spaces in my display/view files, but 4 spaces in everything else
Follow all guidelines described in the course notes on interface.
Follow all guidelines described in the course notes on code style.
Running your site's production URL through the w3 validator should not produce any errors or warnings. (If you disagree with any of the warnings the validator is showing, email me ahead of time so we can confer on whether ignoring the warning is acceptable).
Follow all specifications previously outlined for P1, e.g. project should be in its own public repo, production and repo version of code should be in sync, etc.
Follow any/all other best practices not explicitly mentioned above but discussed in lecture/notes.