diff --git a/README.md b/README.md index 18bedbd..03ebd7d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ This repository contains several guides on software development at the lab of digital and computational demography. -This is work in progress, expect changes in the next weeks and months. I am happy to receive help, criticism +This is work in progress, expect changes in the next weeks and months. I am happy to receive help, criticism and contributions. * How to [request and perform code reviews](HowToCodeReview.md) * [Writing good readme-files](writingGoodReadmes.md) + + * Start [using Git and Github](startWithGit.md) diff --git a/writingGoodReadmes.md b/writingGoodReadmes.md index f3054b1..4707ab9 100644 --- a/writingGoodReadmes.md +++ b/writingGoodReadmes.md @@ -27,9 +27,9 @@ If your software is not yet ready for other users or old and deprecated - add a Describe what this software is. What it is like, what it is not like. Why is it useful. A picture or a working demonstration would be cool. If your software is still in beta-status and still contains many bugs, it would be good to include a warning about the current status. -#### Related work (optional) +### Related work (optional) -List similar software and explain how this is different. +List similar software and explain how yours is different. ### Installation