occam-verify-cli 0.0.399 → 0.0.400
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/bin/action/help.js +0 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,56 @@
|
|
|
2
2
|
|
|
3
3
|
[Occam](https://github.com/djalbat/occam)'s verifier.
|
|
4
4
|
|
|
5
|
+
*This readme file is mostly for developers. For instructions tailored to end users, see the following:*
|
|
6
|
+
|
|
7
|
+
https://openmathematics.org/how-to-contribute
|
|
8
|
+
|
|
9
|
+
### Contents
|
|
10
|
+
|
|
11
|
+
- [Installation](#installation)
|
|
12
|
+
- [Usage](#usage)
|
|
13
|
+
- [Building](#building)
|
|
14
|
+
- [Contact](#contact)
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
If you would like to contribute or would simply like to have a look at the code, you can clone the repository with [Git](https://git-scm.com/)...
|
|
19
|
+
|
|
20
|
+
git clone https://github.com/djalbat/occam-verify-cli.git
|
|
21
|
+
|
|
22
|
+
...and then install the dependencies with [npm](https://www.npmjs.com/) from within the project's root directory:
|
|
23
|
+
|
|
24
|
+
npm install
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
These are the commands and options:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
verify [<options>] [<argument>] Verify the specified project
|
|
32
|
+
|
|
33
|
+
verify [<command>] [<options>] [<argument>]
|
|
34
|
+
|
|
35
|
+
Commands:
|
|
36
|
+
|
|
37
|
+
help Show this help
|
|
38
|
+
|
|
39
|
+
version Show the version
|
|
40
|
+
|
|
41
|
+
Options:
|
|
42
|
+
|
|
43
|
+
--help|-h Show this help
|
|
44
|
+
|
|
45
|
+
--version|-v Show the version
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Building
|
|
49
|
+
|
|
50
|
+
Automation is thanks to [npm scripts](https://docs.npmjs.com/misc/scripts), have a look at the `package.json` file. The pertinent commands are:
|
|
51
|
+
|
|
52
|
+
npm run build-debug
|
|
53
|
+
npm run watch-debug
|
|
54
|
+
|
|
5
55
|
## Contact
|
|
6
56
|
|
|
7
57
|
* james.smith@openmathematics.org
|
package/bin/action/help.js
CHANGED