diff options
| author | Thomas White <taw@bitwiz.org.uk> | 2010-12-02 20:20:22 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2012-02-22 15:27:07 +0100 |
| commit | 4560e69b51b9e517bc5c7edbb80bc567f5bae2fd (patch) | |
| tree | 53b2f770aa1a8826aa343dbd820722db966eafa5 /README | |
| parent | 27d14f0b1391bbc6d667eb9c82e78c3b02052e5a (diff) | |
Update fussiness
Diffstat (limited to 'README')
| -rw-r--r-- | README | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -109,22 +109,26 @@ $ ./configure --disable-gtk --disable-png --disable-libtiff Program name ------------ -There seems to be a tendency to capitalise the names of programs in -publications. It's not 1970 any more, and programs can have capitalisation -any way we choose, not just all capitals. I hope you can forgive me for being -fussy about how my work is referred to in publications and talks. +There seems to be a tendency to capitalise all the letters in the names of +programs in scientific publications. It's not 1970 any more, and programs can +have capitalisation any way we choose, not just all capitals. The name for the overall software suite is "CrystFEL", with this being the only acceptable capitalisation. The individual programs should always be referred to -with all letters in lower case, exactly as written earlier in this file. Put -the names in quotes if they sound strange to you. +with all letters in lower case, exactly the same as the names of the binaries. +Put the names in quotes if this sounds strange to you. The only exception is if +the name of the program comes at the start of a sentence, or in a title, or +similar position where a word would normally be capitalised. In most cases, it will be more appropriate to refer to the overall suite than to one of its constituent programs. The following are NOT acceptable forms: "CRYSTFEL", "crystFEL", "Crystfel", -"Indexamajig", "INDEXAMAJIG", "PATTERN_SIM", "Pattern_Sim", "Pattern_sim". +"INDEXAMAJIG", "PATTERN_SIM", "Pattern_Sim" and "Pattern_sim". In addition, CrystFEL is made up of "programs", not "routines" nor "procedures". (The "programs" in turn are made up from "routines" and "procedures", but unless you are exploring the source code, there's no need for you to know about that). + +I hope you can forgive me for being fussy about how my work is referred to in +publications and talks. |