From a3144899f93c16b92064b92a5ec410dc54553160 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Wed, 17 Dec 2014 20:04:38 -0800 Subject: [PATCH] README.md: Change headers ("Students" -> "For leaners") This is based on swcarpentry/workshop-template@5451fb9c1 (Enumerating setup/run instructions for installation test scripts, 2014-12-17). Greg suggested he switch from "Students" to "Learners" because some professors attend workshops as students but don't feel comfortable being called students [1]? Or something like that. I don't mind either way, so we'll just go with Greg's preference. The addition of a "For" in the section headings seems like a good change though, since it makes it clear that the noun in the heading marks the intended audience for that section, not the intended subject. I went with 'Sentence case' titles because I think they're more readable and it's easier to be consistent. There are a number of folks who agree with me [2,3], including (apparently) the Oxford Guide to Style [4] (I'm ok with title case for book and organization titles ;). Although the American Psychological Association perfers 'Title Case' for the first two levels of headings as well [5]. [1]: https://github.com/swcarpentry/workshop-template/pull/89#issuecomment-67718126 [2]: http://www.snappysentences.com/sentence-case-v-title-case/ [3]: http://www.stickycontent.com/blog/are-you-team-title-case-or-team-sentence-case.php [4]: http://ux.stackexchange.com/a/48620 [5]: http://blog.apastyle.org/apastyle/2012/03/title-case-and-sentence-case-capitalization-in-apa-style.html Based-on-patch-by: Greg Wilson --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad118cc..35ff0d2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Students -======== +For learners +============ This directory contains scripts for testing your machine to make sure you have the software you'll need for your workshop installed. See @@ -45,8 +45,8 @@ option: os.name : posix … -Instructors -=========== +For instructors +=============== `swc-installation-test-1.py` is pretty simple, and just checks that the students have a recent enough version of Python installed that -- 2.26.2