Homework, Part 3 - Readme.md and a Submission
To finish up your homework assignment this week we need to complete a few more steps.
(Note: In the above video, please ignore the bit about uploading to the GitHub wiki, you will upload your links as a forum submission in Moodle.)
1: readme.md
The first thing you need to do is create and write your readme.md document. If you are using the “empty-project” from this course’s website, there should already be a readme.md file in the project directory. You simply need to delete and replace the contents of this file.
If there is not a readme.md file in your sketch directory for some reason, please create the file, within your hw-3/ directory, using one of the methods discussed in the first two weeks.
The First & Third Lines
The first line in your readme file should be your name.
The third line of your readme file should be a link to your working “Hello World!” sketch.
As an example;
Michael Musick
["Hello World!" Sketch](https://michaelmusick.github.io/120-work/hw-3/)
The Rest of the File
In your readme, you should discuss your experiences this week, as well as your progress, problems, breakthroughs, and discoveries.
I would suggest you use the following questions as a guideline.
- Summarize the work you did this homework cycle. Paying particular attention to the individual choices you made.
- What steps did you take to complete the assignment?
- Did you have any problems or issues? How did you solve these? Did you post about these to the class repo issue tracker? Did you receive any useful feedback from your classmates?
- Is there anything in particular you learned that you would like to discuss further?
- What issues did you help your fellow classmates out with this past homework cycle?
NOTE: The above questions should serve as a guideline for your written readme. Please do not answer these questions as though they were part of a set of number questions. These readme’s should be well thought out, and written documents.
REMEMBER: As a reminder, you should include pictures when appropriate. You should also use structure markup (i.e. headings) to create a clean, easily readable document.
2: Commit Changes
After finishing your readme, commit your additional changes to your git repo and sync the changes with the remote repo on GitHub.com.
3: Submit Homework Links
Finally, we need to submit our homework links to the course moodle forum.
- To do this, we need to first visit our repository on GitHub.com.
- You should then navigate to the top level of your
hw-3/directory. When you are there, you should see all of your code files for this week, along with your readme down below.
- Copy the URL for this current webpage.
- In a new browser tab/window, open the Moodle Shell for this Course and navigate to the week 3 - HW3 - Submission Forum.
- There you should create a new post and add;
- Link to your
hw-3/github repo directory, - and a link to your live p5 “Hello World!” sketch
- Link to your
My submission would look like;
That is it for HW-3!