Project 1
CURRENT BUGS
- re-loading to page
- reset sets the characters further back than before
explanations of the technologies used,
the approach taken
installation instructions
unsolved problems
etc.
rief or no discussion of concepts which were stated in lecture (eg, how an AVL tree does its rotations) Succinct discussion of important design issues that were faced, the solution that was decided upon, as well as the rationale behind the decision. For the Shakespeare/Bacon or extra credit analyses, it was important to state: the problem/question they were answering, any relevant data that they collected, an answer to the stated question, which is justified by the collected data.
GITHUB explanation:
Synopsis
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Code Example
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Motivation
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Installation
Provide code examples and explanations of how to get the project.
API Reference
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Tests
Describe and show how to run the tests with code examples.
Contributors
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
License
A short snippet describing the license (MIT, Apache, etc.)