Skip to content

Commit 4bc6068

Browse files
authored
Merge pull request rocq-community#4 from erikmd/update-readme
Update the Readme (Add doc for "qualified" & Improve details)
2 parents c71bac4 + e9fa1f4 commit 4bc6068

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Readme.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ One way to test the plugin is to follow the following steps:
1111
* Retrieve the plugin and compile it:
1212

1313
git clone ...
14-
git checkout (* the correct branch *)
1514
cd paramcoq
15+
git checkout (* the correct branch *)
1616
make
1717
sudo make install
1818

@@ -28,12 +28,16 @@ Available commands
2828
==================
2929

3030
The default arity is 2.
31-
The default name is automatically generated when translating a constant (otherwise you need to provide it).
3231

33-
- Parametricity [Recursive] *ident* [as *name*] [arity *n*].
32+
- Parametricity *ident* as *name* [arity *n*].
33+
34+
Declare the translation named *name* from the translation of the constant or inductive *ident*.
35+
36+
- Parametricity [Recursive] *ident* [arity *n*] [qualified].
3437

35-
Declare the translation named *name* from the translation of the constant or the inductive *ident*.
36-
You can use the recursive option to recursively translate all the constant and inductives which are used by *ident*.
38+
The default name for the translation of the constant or inductive *ident* is automatically generated (from its unqualified name).
39+
You can use the `Recursive` option to recursively translate all the constants and inductives which are used by *ident*.
40+
You can use the `qualified` option to use a qualified default name for the translated constants and inductives. The default name then has the form `Module_o_Submodule_o_ident` if *ident* lies in the `Module.Submodule` namespace.
3741

3842
- Parametricity Translation *term* [as *name*] [arity *n*].
3943

@@ -48,8 +52,8 @@ Recursively translate everything in a module.
4852
Declare *term* to be the translation of a constant.
4953
Useful to translate terms containing section variables, or axioms.
5054

51-
Note that all that both translating a term or module may lead to proof obligations (for some fixpoints and opaque terms if you did not import ProofIrrelevence).
55+
Note that both translating a term or module may lead to proof obligations (for some fixpoints and opaque terms if you did not import `ProofIrrelevence`).
5256

53-
- [Global | Local] Parametricity Tactict := t.
57+
- [Global | Local] Parametricity Tactic := t.
5458

55-
Use the tactic t to solve proof obligations generated by the Parametricity command.
59+
Use the tactic t to solve proof obligations generated by the `Parametricity` command.

0 commit comments

Comments
 (0)