Skip to content

Commit 6b130ea

Browse files
committed
Updated README
1 parent 8ada5cb commit 6b130ea

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,46 @@ Run `make .merlin` to create the `.merlin` file.
1515

1616
## New Vernacular Commands
1717

18-
- `CWTest string? qualid Assumes qualid*`
18+
- `CWAssert string? qualid Assumes qualid*`
1919

2020
This command fails if the tested `qualid` depends on an axiom which is not listed after `Assumes`:
2121

2222
```coq
23-
CWTest "Testing lemma" lemma Assumes proof_irrelevance functional_extensionality.
23+
CWAssert "Testing lemma" lemma Assumes proof_irrelevance functional_extensionality.
2424
```
25-
The string argument after `CWTest` is an optional message.
25+
The string argument after `CWAssert` is an optional message.
26+
27+
- `CWAssert string? qualid : term`
28+
29+
Checks if the type of `qualid` is convertible to the type given by `term`.
30+
31+
```coq
32+
CWAssert "Testing type" lemma : (forall x, x > 0).
33+
```
34+
The string argument after `CWAssert` is an optional message.
35+
36+
Note that the `term` should be in parentheses.
2637

2738
- `CWGroup string`
2839

29-
Begins a group of tests.
40+
Begins a group of tests (outputs `<DESCRIBE::>`).
41+
42+
Groups can be nested. But all tests should be performed after `CWTest` in nested groups.
3043

3144
- `CWEndGroup`
3245

3346
Ends a group of tests.
3447

48+
- `CWTest string`
49+
50+
Begins a test case (outputs `<IT::>`).
51+
52+
Test cases cannot be nested.
53+
54+
- `CWEndTest`.
55+
56+
Ends a test case. This command is optional before `CWTest` and `CWEndGroup`.
57+
3558
- `CWFile string? Size < int`
3659

3760
Tests if the size of a file (the first string argument) is less than the second argument.
@@ -48,8 +71,9 @@ Run `make .merlin` to create the `.merlin` file.
4871

4972
## Examples
5073

51-
See [theories/Demo.v](theories/Demo.v) and [theories/Demo2.v](theories/Demo2.v)
52-
for more examples.
74+
See [cw_example/SolutionTest.v](cw_example/SolutionTest.v).
75+
76+
More examples are in [theories/Demo.v](theories/Demo.v) and [theories/Demo2.v](theories/Demo2.v).
5377

5478
Compiling demo files:
5579
```

0 commit comments

Comments
 (0)