summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTimotej Lazar <timotej.lazar@fri.uni-lj.si>2016-08-09 14:49:24 +0200
committerTimotej Lazar <timotej.lazar@fri.uni-lj.si>2016-08-09 14:49:24 +0200
commitbfd0dab7b66702086da0527e6b5b69c3b7a32f67 (patch)
tree9ad12564bc5aa91111bb21f3f4ef3b7ad73b2637
parenta609aa835e543e53647d55e1992f8c7654f68a30 (diff)
Add some style guidelines to readme
-rw-r--r--readme.md37
1 files changed, 37 insertions, 0 deletions
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)
+ * ⊂
+ * ⊆
+ * ⊃
+ * ⊇