This is a template for using your repo's README.md as your project web page. I recommend you copy and paste into your README file. Delete this line and the one above it, customize everything else. Make it look good!
You are welcome to re-use text you wrote for your proposal, but make sure to edit future tense to past tense. Now, you are explaining what happened, rather than describing what you plan to do.
It is also important to update the architecture diagram to reflect what actually was built (vs. what was planned). If you are confident in your own work, you can even indicate the part that was planned but not completed---e.g., this example.
You may also describe how the initial plan was transformed.
But make sure any language that reads like "we will do..." is removed.
##Authors Person One
Person Two
##Overview A brief description of the project is given here. The description is 1 to 3 sentences long. Be concise and clear.
##Screenshot (insert a screenshot here. You may opt to get rid of the title for it. You need at least one screenshot. Make it actually appear here, don't just add a link.)
Here's a demonstration of how to display an image that's uploaded to this repo:
##Concepts Demonstrated Identify the OPL concepts demonstrated in your project. Be brief. A simple list and example is sufficient.
- Data abstraction is used to provide access to the elements of the RSS feed.
- The objects in the OpenGL world are represented with recursive data structures.
- Symbolic language processing techniques are used in the parser.
##External Technology and Libraries Briefly describe the existing technology you utilized, and how you used it. Provide a link to that technology(ies).
##Favorite Scheme Expressions ####Mark (a team member) Each team member should identify a favorite expression or procedure, written by them, and explain what it does. Why is it your favorite? What OPL philosophy does it embody? Remember code looks something like this:
(map (lambda (x) (foldr compose functions)) data)####Lillian (another team member) This expression reads in a regular expression and elegantly matches it against a pre-existing hashmap....
(let* ((expr (convert-to-regexp (read-line my-in-port)))
(matches (flatten
(hash-map *words*
(lambda (key value)
(if (regexp-match expr key) key '()))))))
matches)##Additional Remarks Anything else you want to say in your report. Can rename or remove this section.
#How to Download and Run You may want to link to your latest release for easy downloading by people (such as Mark).
Include what file to run, what to do with that file, how to interact with the app when its running, etc.