You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-16Lines changed: 0 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# WhispArg
2
2
A lightweight, single-header C++ library for quickly parsing command-line arguments in throwaway or prototype code.
3
3
4
-
---
5
-
6
4
## 1. What is WhispArg?
7
5
8
6
**WhispArg** is a C++ command-line argument parsing library designed for “throwaway” code, offering a **lightweight** approach in a **single header** file.
@@ -12,8 +10,6 @@ The name originates from “Whisper,” conveying the notion of something that q
12
10
> - “Whisp” = A shortened form of “Whisper,” evoking a small, temporary presence.
13
11
> - “Arg” = Short for “Arguments.”
14
12
15
-
---
16
-
17
13
## 2. Features
18
14
19
15
-**Designed for Throwaway Code**
@@ -28,22 +24,16 @@ The name originates from “Whisper,” conveying the notion of something that q
28
24
> **Note**
29
25
> WhispArg is intended for lightweight, temporary usage. For large-scale CLI needs, please consider more feature-rich libraries.
30
26
31
-
---
32
-
33
27
## 3. Installation
34
28
35
29
1. Download or copy `WhispArg.hpp` from the [WhispArg repository](https://github.com/yourname/WhispArg).
36
30
2. Place `WhispArg.hpp` in the same directory as your project source code, or in any header include path of your choice.
37
31
3. Include it in your code via `#include "WhispArg.hpp"`.
38
32
39
-
---
40
-
41
33
## 4. Sample Code
42
34
43
35
For examples and usage details, see the sample code located under `./main/` in the repository.
44
36
45
-
---
46
-
47
37
## 5. Concept & Usage Scenarios
48
38
49
39
WhispArg is optimized for scenarios like small test code, educational scripts, or prototypes. It is not intended for large-scale, long-term usage.
@@ -55,23 +45,17 @@ WhispArg is optimized for scenarios like small test code, educational scripts, o
55
45
> This library is a simple, lightweight tool that does not support complex subcommands or intricate option structures.
56
46
> **“Quick to implement, quick to discard.”** For more advanced command-line parsing needs, please use a more robust library.
57
47
58
-
---
59
-
60
48
## 6. Development Policy & Future Plans
61
49
62
50
-**Keep It Minimal**
63
51
- We will preserve its throwaway-oriented concept by keeping feature requests minimal.
64
52
-**Open-Source**
65
53
- GitHub issues and pull requests are welcome, but note that it is a simple utility and not intended to grow into a full-featured tool.
66
54
67
-
---
68
-
69
55
## 7. License
70
56
71
57
This project is licensed under the [MIT License](LICENSE). See the `LICENSE` file in the repository for details.
72
58
73
-
---
74
-
75
59
## 8. Summary
76
60
77
61
WhispArg is a lightweight, single-header C++ library for simple command-line argument parsing.
0 commit comments