You are expected to turn in a README.txt file with your source codes for every project except the last one. The README file is to let users to better use and understand your codes. For example, it can let graders and Ying know how to compile and run your codes. It is also a good way to remind you when you want to reuse your codes later.
The README file serves for all the source codes in your submission, including C and the selected languages if there are coding tasks for the selected langauge. It needs to contain the usage and outputs of your source codes. In addition, the known bugs of your codes should also be indicated in the README file. Please also indicate the version of your C compiler, your operating system, and the OS version in the README file.
To check whether you've made your README file clear, you may ask yourself the following questions:
Here is a template you can use.
Wiki is the write-up for your selected languages in CS333. The final product of this writing should be a tutorial for your selected languages. A good tutorial should be easy to read and understand, which makes the organization and content of your write-up important.
To check whether you've made your write-up easy to read and understand, you may ask yourself the following questions:
Here is a recommended layout.
Ying Li CS333 | |_Ying’s Explorations in R | | | |_P1 | |_P2 | |_... | |_Ying’s Notes in JS | | | |_P1 | |_P2 | |_...
© 2017 Ying Li. Page last modified: .