Consult the general homework guidelines, although much does not to apply to this simple assignment.
Recall the tutorial where we test drive your software installation and account configuration. DO IT.
Make sure you’ve accepted my invitation to join the STAT 545 GitHub Organization.
Due before class Tuesday 2014-09-22. Or later that day, if terrible things happen, and you need a consultation during class or office hours. This is the last time we’ll flex on due date just because of software and configuration issues. SORT THIS OUT ASAP.
The goal is to test your software installation, our GitHub setup, and our homework submission process via an Issue.
README.md
We created this repository for you but it is empty. When you first visit, you should see a screen like this. You need to edit your README.md
file to welcome your visitors (you, STAT545 instructor/TAs, STAT545 peers).
If you are already familiar with GitHub, edit the README.md
any way you wish.
If you are new to Git and GitHub, click on the README
link in the area that looks like a file browser. Click on the pencil and make an edit. Then head down to “Commit changes”. Enter a short commit message. Then click “Commit changes”. This is how you can edit files in GitHub repository through the browser. If you are still mystified by Git(Hub), you can use this browser-based method to edit README.md
until you get more comfortable with using Git locally and pushing to GitHub. However, if at all possible, we want you to pilot a more powerful workflow:
Go take possession of your STAT 545 private repository and have at it.
At the very least, change README.md
to something like “This is the repository of Jenny Bryan,” just to prove you have been there. Practice making a link, for example, to the main STAT545 webpage. Much better is to introduce yourself to the class; this page is private to STAT 545 but will be visible to all students and staff. Feel free to read up on Markdown and practice with some of the syntax. Here’s a simple example file, as automatically rendered by GitHub, and here is the raw source.
Include a description of how you got the changes into README.md
on GitHub.
You’re encouraged to reflect on what was hard/easy, problems you solved, helpful tutorials you read, etc.
Follow instructions on How to submit homework
Check minus: README.md
says equivalent of “This is the repository of Jenny Bryan”. All work done via browser at github.com … but that’s just a guess, because student doesn’t actually say how it was done.
Check: something in between
Check plus: README.md
provides a proper introduction of student to the class. It also demonstrates experimentation with 4 or more aspects of the Markdown syntax. Examples: section headers, links, bold, italic, bullet points, image embed, etc. The student describes how they got the changes into README.md
and offers a few reflections on their GitHub workflow and their experience with Markdown.