Skip to content

Commit 5b762ac

Browse files
committed
Add usage sections
1 parent da101e4 commit 5b762ac

File tree

1 file changed

+46
-12
lines changed

1 file changed

+46
-12
lines changed

README.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,61 @@
66
77
[![CI](https://github.com/cl-qob/cli/actions/workflows/test.yml/badge.svg)](https://github.com/cl-qob/cli/actions/workflows/test.yml)
88

9+
## 🔧 Usage
10+
11+
```
12+
NAME:
13+
qob - CLI for building, running, testing, and managing your Common Lisp dependencies
14+
15+
USAGE:
16+
qob [global-options] [<command>] [command-options] [arguments ...]
17+
18+
OPTIONS:
19+
--help display usage information and exit
20+
--no-color enable/disable color output
21+
--version display version and exit
22+
-a, --all enable all flag
23+
-g, --global change default workspace to ~/.qob/
24+
-v, --verbose <INT> set verbosity from 0 to 5 [default: 3]
25+
26+
COMMANDS:
27+
build Build the executable
28+
dists List out all installed dists
29+
install Install packages
30+
install-deps Automatically install system dependencies
31+
uninstall Uninstall packages
32+
list List the registered system
33+
34+
AUTHORS:
35+
Jen-Chieh Shen <jcs090218@gmail.com>
36+
37+
LICENSE:
38+
MIT
39+
```
40+
941
## ⚜️ License
1042

11-
Permission is hereby granted, free of charge, to any person obtaining a copy
12-
of this software and associated documentation files (the "Software"), to deal
13-
in the Software without restriction, including without limitation the rights
14-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15-
copies of the Software, and to permit persons to whom the Software is
43+
Permission is hereby granted, free of charge, to any person obtaining a copy
44+
of this software and associated documentation files (the "Software"), to deal
45+
in the Software without restriction, including without limitation the rights
46+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
47+
copies of the Software, and to permit persons to whom the Software is
1648
furnished to do so, subject to the following conditions:
1749

18-
The above copyright notice and this permission notice shall be included in all
50+
The above copyright notice and this permission notice shall be included in all
1951
copies or substantial portions of the Software.
2052

21-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
53+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
54+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
55+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
56+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
57+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
58+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2759
SOFTWARE.
2860

2961
See [`LICENSE`](./LICENSE) for details.
3062

3163

3264
<!-- Links -->
65+
66+
[Quicklisp]: https://www.quicklisp.org/beta/

0 commit comments

Comments
 (0)