Browse Source

Moved all to main README

Alois Mahdal (@azzgoat) 11 years ago
parent
commit
e3a534b1a7
2 changed files with 98 additions and 102 deletions
  1. 98
    3
      README.md
  2. 0
    99
      trail0.md

+ 98
- 3
README.md View File

@@ -1,4 +1,99 @@
1
-sugar-trail
2
-===========
3 1
 
4
-idea project: set of syntax rules and a PL to allow for easy writing of test procedures
2
+#Synopsis#
3
+
4
+    Header: value of any kind
5
+    Other-header: name1=value1; name2=value2
6
+    Another-one: something else
7
+
8
+    After an empty linem, body starts. Just like MIME.
9
+
10
+    The body is basically Markdown with some modifications discussed later.
11
+
12
+    #case name#
13
+    1. instruction
14
+       > expected result (or check point, or oracle)
15
+       > another expected result {fam>10} {os~win*}
16
+    2. cond. instruction
17
+       * yes: opt 1
18
+       * no: opt 2
19
+    0. Assertion (specifically zero, can be anywhere)
20
+    3. another instruction
21
+
22
+
23
+#Descrription#
24
+
25
+Basic form is similar to MIME.  First headers, then, after one empty line, the
26
+body, up to the EOF.  Just like in MIME, headers are only for mete-data--thery
27
+are not visible in the final outpput.
28
+
29
+Inside header, various parameter lranges like OSes, architectures, product
30
+editions or hardware types can be declared.  Later entities (e.g. instructions)
31
+can be conditioned using these.
32
+
33
+This is also meant to allow for generation of set of ready procedures with
34
+variations of parameters.
35
+
36
+
37
+#Rules#
38
+  * if assertion -or- instruction fails
39
+    * IN is generated
40
+    * rest of test case is skipped
41
+  * if expected result fails
42
+    * IN is generated
43
+    * TC goes on
44
+
45
+#Terms#
46
+ * *IN* - incident note
47
+    * note itself
48
+    * bug eport?
49
+ * *TC* - test case
50
+ * *ST* - sugar trail (trail of test cases)
51
+
52
+
53
+-----------------------------------------------------------------------------
54
+
55
+
56
+Name: 
57
+
58
+
59
+##Putting giraffe into fridge##
60
+ 1. Open the fridge
61
+ 2. Put the giraffe into the fridge
62
+ 3. Close the fridge
63
+
64
+##Putting elephant into fridge##
65
+ 1. Open the fridge
66
+ 2. Take the giraffe put of the fridge
67
+ 3. Put the elephant into the fridge
68
+ 4. Close the fridge
69
+
70
+##Emptying fridge##
71
+ 1. Open the fridge
72
+ 2. What is inside the fridge?
73
+    * elephant: take out the elephant
74
+    * giraffe: take out the giraffe
75
+ 3. Closer the fridge
76
+ !. Fridge is empty
77
+
78
+
79
+##Taking elephant out of the fridge##
80
+ 0. There is an elephant inside the firdge
81
+ 1. Open the fridge
82
+    > fridge opens well
83
+ 2. Look inside the fridge
84
+    > you see elephant
85
+    > elephant has a pullover
86
+    > elephant is not cold
87
+ 3. Take the elephant out of the fridge
88
+    > elephant does not fight
89
+    > elephant looks happier outside the fridge
90
+    > it does not make too much sound
91
+ 0. everybody is sleeping
92
+ 4. Close the fridge
93
+    > Fridge closes well
94
+
95
+
96
+#TODO#
97
+
98
+* define keyboard shortcuts (not the ugly `<key>Shift</key>+<key>F8</key>)
99
+

+ 0
- 99
trail0.md View File

@@ -1,99 +0,0 @@
1
-
2
-#Synopsis#
3
-
4
-    Header: value of any kind
5
-    Other-header: name1=value1; name2=value2
6
-    Another-one: something else
7
-
8
-    After an empty linem, body starts. Just like MIME.
9
-
10
-    The body is basically Markdown with some modifications discussed later.
11
-
12
-    #case name#
13
-    1. instruction
14
-       > expected result (or check point, or oracle)
15
-       > another expected result {fam>10} {os~win*}
16
-    2. cond. instruction
17
-       * yes: opt 1
18
-       * no: opt 2
19
-    0. Assertion (specifically zero, can be anywhere)
20
-    3. another instruction
21
-
22
-
23
-#Descrription#
24
-
25
-Basic form is similar to MIME.  First headers, then, after one empty line, the
26
-body, up to the EOF.  Just like in MIME, headers are only for mete-data--thery
27
-are not visible in the final outpput.
28
-
29
-Inside header, various parameter lranges like OSes, architectures, product
30
-editions or hardware types can be declared.  Later entities (e.g. instructions)
31
-can be conditioned using these.
32
-
33
-This is also meant to allow for generation of set of ready procedures with
34
-variations of parameters.
35
-
36
-
37
-#Rules#
38
-  * if assertion -or- instruction fails
39
-    * IN is generated
40
-    * rest of test case is skipped
41
-  * if expected result fails
42
-    * IN is generated
43
-    * TC goes on
44
-
45
-#Terms#
46
- * *IN* - incident note
47
-    * note itself
48
-    * bug eport?
49
- * *TC* - test case
50
- * *ST* - sugar trail (trail of test cases)
51
-
52
-
53
------------------------------------------------------------------------------
54
-
55
-
56
-Name: 
57
-
58
-
59
-##Putting giraffe into fridge##
60
- 1. Open the fridge
61
- 2. Put the giraffe into the fridge
62
- 3. Close the fridge
63
-
64
-##Putting elephant into fridge##
65
- 1. Open the fridge
66
- 2. Take the giraffe put of the fridge
67
- 3. Put the elephant into the fridge
68
- 4. Close the fridge
69
-
70
-##Emptying fridge##
71
- 1. Open the fridge
72
- 2. What is inside the fridge?
73
-    * elephant: take out the elephant
74
-    * giraffe: take out the giraffe
75
- 3. Closer the fridge
76
- !. Fridge is empty
77
-
78
-
79
-##Taking elephant out of the fridge##
80
- 0. There is an elephant inside the firdge
81
- 1. Open the fridge
82
-    > fridge opens well
83
- 2. Look inside the fridge
84
-    > you see elephant
85
-    > elephant has a pullover
86
-    > elephant is not cold
87
- 3. Take the elephant out of the fridge
88
-    > elephant does not fight
89
-    > elephant looks happier outside the fridge
90
-    > it does not make too much sound
91
- 0. everybody is sleeping
92
- 4. Close the fridge
93
-    > Fridge closes well
94
-
95
-
96
-#TODO#
97
-
98
-* define keyboard shortcuts (not the ugly `<key>Shift</key>+<key>F8</key>)
99
-