Portfolio Danny Rutten

ReadMe in Git Before and after

Git ReadMe iteration

The previous version and starting point of my git readme can be found by clicking the following link: LO2 / Git ReadMe

I've received feedback on my first iteration of the git readme and it turns out that I've been thinking about it in a wrong way. What I should've done is focus on making a readme that targets developers and tells them how to use my project and how to work in it. So what I've changed in this iteration is pretty much everything.

I've dedicated the entire first section of the readme to how to install my project to your own PC to make use of it or edit it to your own liking. I've also added a section that tells you how to edit the most important aspects of my portfolio with examples. Lastly, I've added a section that tells you how to use the project and how you should look at it. Finally, the languages used section remains unchanged with exception of the links.

Feedback from Joris: "Is it important to have a table of contents in a Git Readme? Or is it better to know how to continue working on the project, and what steps should I have to follow for this. In the context of how transferable is this git repo, not very."

With this feedback in mind, this is the new readme. You can also view it in the git itself: Click here.

Go back