Browse Source

Markup cleanup

Alois Mahdal (@azzgoat) 10 years ago
parent
commit
76b544a264
2 changed files with 24 additions and 17 deletions
  1. 17
    12
      README.md
  2. 7
    5
      TODO.md

+ 17
- 12
README.md View File

@@ -39,20 +39,25 @@ variations of parameters.
39 39
 
40 40
 
41 41
 ##Rules##
42
-  * if assertion -or- instruction fails
43
-    * IN is generated
44
-    * rest of test case is skipped
45
-  * if expected result fails
46
-    * IN is generated
47
-    * TC goes on
42
+
43
+*   if assertion -or- instruction fails
44
+    *   IN is generated
45
+    *   rest of test case is skipped
46
+
47
+*   if expected result fails
48
+    *   IN is generated
49
+    *   TC goes on
48 50
 
49 51
 ##Terms##
50
- * *IN* - incident note
51
-    * note itself
52
-    * bug report against tested subject?
53
-    * bug report against test documentation?
54
- * *TC* - test case
55
- * *ST* - sugar trail (trail of test cases)
52
+
53
+*   *IN* - incident note
54
+    *   note itself
55
+    *   bug report against tested subject?
56
+    *   bug report against test documentation?
57
+
58
+*   *TC* - test case
59
+
60
+*   *ST* - sugar trail (trail of test cases)
56 61
 
57 62
 
58 63
 ##Example##

+ 7
- 5
TODO.md View File

@@ -4,19 +4,21 @@
4 4
 
5 5
 ### Syntax ###
6 6
 
7
-* keyboard shortcuts (not the ugly `<key>Shift</key>+<key>F8</key>)
8
-* TC dependency issues
7
+*   keyboard shortcuts (not the ugly `<key>Shift</key>+<key>F8</key>)
8
+
9
+*   TC dependency issues
9 10
 
10 11
 
11 12
 ### Data model ###
12 13
 
13
-* step identity
14
+*   step identity
14 15
 
15 16
 
16 17
 ### WUI ###
17
-* data persistence (HTML5)
18
+
19
+*   data persistence (HTML5)
18 20
 
19 21
 
20 22
 ## Implementation ##
21 23
 
22
-* everything! :)
24
+*   everything! :)