Browse Source

Fixed headings' hierarchy

Alois Mahdal (@azzgoat) 11 years ago
parent
commit
408c99f727
1 changed files with 10 additions and 11 deletions
  1. 10
    11
      README.md

+ 10
- 11
README.md View File

@@ -4,7 +4,7 @@ sugar-trail
4 4
 Set of syntax rules and a PL to allow for easy writing of test procedures.
5 5
 
6 6
 
7
-#Synopsis#
7
+##Synopsis##
8 8
 
9 9
     Header: value of any kind
10 10
     Other-header: name1=value1; name2=value2
@@ -25,7 +25,7 @@ Set of syntax rules and a PL to allow for easy writing of test procedures.
25 25
     3. another instruction
26 26
 
27 27
 
28
-#Descrription#
28
+##Descrription##
29 29
 
30 30
 Basic form is similar to MIME.  First headers, then, after one empty line, the
31 31
 body, up to the EOF.  Just like in MIME, headers are only for mete-data--thery
@@ -39,7 +39,7 @@ This is also meant to allow for generation of set of ready procedures with
39 39
 variations of parameters.
40 40
 
41 41
 
42
-#Rules#
42
+##Rules##
43 43
   * if assertion -or- instruction fails
44 44
     * IN is generated
45 45
     * rest of test case is skipped
@@ -47,7 +47,7 @@ variations of parameters.
47 47
     * IN is generated
48 48
     * TC goes on
49 49
 
50
-#Terms#
50
+##Terms##
51 51
  * *IN* - incident note
52 52
     * note itself
53 53
     * bug eport?
@@ -55,24 +55,23 @@ variations of parameters.
55 55
  * *ST* - sugar trail (trail of test cases)
56 56
 
57 57
 
58
------------------------------------------------------------------------------
59
-
58
+##Example##
60 59
 
61 60
 Name: 
62 61
 
63 62
 
64
-##Putting giraffe into fridge##
63
+###Putting giraffe into fridge###
65 64
  1. Open the fridge
66 65
  2. Put the giraffe into the fridge
67 66
  3. Close the fridge
68 67
 
69
-##Putting elephant into fridge##
68
+###Putting elephant into fridge###
70 69
  1. Open the fridge
71 70
  2. Take the giraffe put of the fridge
72 71
  3. Put the elephant into the fridge
73 72
  4. Close the fridge
74 73
 
75
-##Emptying fridge##
74
+###Emptying fridge###
76 75
  1. Open the fridge
77 76
  2. What is inside the fridge?
78 77
     * elephant: take out the elephant
@@ -81,7 +80,7 @@ Name:
81 80
  !. Fridge is empty
82 81
 
83 82
 
84
-##Taking elephant out of the fridge##
83
+###Taking elephant out of the fridge###
85 84
  0. There is an elephant inside the firdge
86 85
  1. Open the fridge
87 86
     > fridge opens well
@@ -98,7 +97,7 @@ Name:
98 97
     > Fridge closes well
99 98
 
100 99
 
101
-#TODO#
100
+##TODO##
102 101
 
103 102
 * define keyboard shortcuts (not the ugly `<key>Shift</key>+<key>F8</key>)
104 103