README

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 should cover all source code in your submission, including C and the selected languages used for coding tasks. It should include instructions for usage and expected outputs, as well as any known bugs in the code. Additionally, the version of the C compiler, operating system, and OS version should be included in the README file.

To check whether you've made your README file clear, you may ask yourself the following questions:

• Does the README file identify the purpose and author of containing directory's contents?
• Does the README file list every other file in the directory along with a short description of its purpose?
• Does the README file use spacing and indentation to make its organization easily comprehended by the reader?
• Does the README file include the compilation environment (i.e. the operating system it was developed on and the version of the compiler/interpreter that was used in development)?
• Does the README file describe how to install (if necessary), compile (if necessary), and run the any programs in the directory?
• Does the README file describe any command line arguments necessary for running programs in the directory?
• Does the README file show the outputs of programs in the directory?
• For the C assignments in CS333, the README serves as the report (for just the C-programming part). If your README is part of such a project, does it contain the information required by the tasks in the C-programming part of the project instructions? and only those?
• Did you indicate the Google Sites URL for the selected language report at the top of the README file?
• If you have taken any coding extensions, does the README have a session for them?

Here is a template you can use.

Google Sites

Google Sites is used for the report for your selected languages in CS333. The final product of the report 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 report important.

To check whether you've made your report easy to read and understand, you may ask yourself the following questions:

• Organization
  • Is there a main page that indicates the main purpose of the page collection (e.g. indicating something like "this is a set of pages describing how a particular language implements standard programming language features")?
  • Does the main page have a title (e.g. Ying Li CS 333, Ying’s Explorations in R, Ying’s Notes in JS)?
  • On the main page, are there clearly organized links to supporting pages?
  • Does each supporting page have a title that indicates its role in the set of pages?

  Here is a recommended layout.

  	Ying Li CS333 (Home Page)
  	|_ P1 (subpage)
  	|
  	|_Ying’s Explorations in R (a section on the home page) 
  	| |
  	| |_P1 (listed in the section with a link to a subpage for P1)
  	| |_P2 (listed in the section with a link to a subpage for P2)
  	| |_...
  	|
  	|_Ying’s Notes in JS (a section on the home page)
  	| |
  	| |_P1 (listed in the section with a link to a subpage for P1)
  	| |_P2 (listed in the section with a link to a subpage for P2)
  	| |_...
  

• Content
  • Does the text describe what the language feature we are asking you to explain?
  • Does the code snippet illustrate the language feature that we are asking you to explain?
  • Does the text describe what aspects of the code snippet best illustrate the language feature we are asking you to explain?
  • Is the code snippet as short as possible?

© 2023 Ying Li. Page last modified: .