From bfd0dab7b66702086da0527e6b5b69c3b7a32f67 Mon Sep 17 00:00:00 2001 From: Timotej Lazar Date: Tue, 9 Aug 2016 14:49:24 +0200 Subject: Add some style guidelines to readme --- readme.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/readme.md b/readme.md index da79939..7f9fbc0 100644 --- a/readme.md +++ b/readme.md @@ -217,3 +217,40 @@ Problem files razdalja = v ** 2 * sin(2 * kot_rad) / g print("Kroglo bo odneslo", razdalja, "metrov.") ''' + + +Style +===== + +Please observe the following stylistic rules when adding or translating +problems. + + * Wrap lines at 80 columns (not a hard rule). + +Special characters +------------------ + +Use appropriate Unicode characters wherever possible. If your setup makes it +difficult to enter these characters, copy them from this file. + + * "foo" → “foo” (english) or „foo“ (slovene) + * ' → ’ (typographic apostrophe) + * ... → … (ellipsis) + * 2x3 → 2×3 (multiplication sign) + * <= → ≤ + * >= → ≥ + * -> → → + * => → ⇒ + * -- → – (en dash) + * :) → ☺ + * ;) → 😉 + +Some other useful characters: + + * ∪ (set union) + * ∩ (set intersection) + * ∖ (set difference) + * ⊂ + * ⊆ + * ⊃ + * ⊇ -- cgit v1.2.1