Skip to content
This repository was archived by the owner on Nov 28, 2024. It is now read-only.

Commit 275745e

Browse files
committed
Update help&&Readme.md
1 parent 60e2142 commit 275745e

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,25 @@
66
Yoshinon ~~(よしのん)~~ is a whiptail-like dialog box written with Bubble Tea (Go).
77
The command-line usage is very similar to dialog/whiptail.
88
## Usage:
9-
As we all know, premature optimization is the root of all evil, so this will be done after I get all the modules working.
9+
```
10+
Box options:
11+
12+
--msgbox [options] <text> <height> <width>
13+
--yesno [options] <text> <height> <width>
14+
--infobox [options] <text> <height> <width>
15+
--inputbox [options] <text> <height> <width> [init]
16+
--passwordbox [options] <text> <height> <width>
17+
--menu [options] <text> <height> <width> <listheight> [tag item] ...
18+
--checklist [options] <text> <height> <width> <listheight> [tag item status]...
19+
--radiolist [options] <text> <height> <width> <listheight> [tag item status]...
20+
--gauge [options] <text> <height> <width>
21+
22+
Options:
23+
24+
--border [rounded/normal/thick/double/hidden]
25+
--help print this message
26+
--version print version information
27+
```
1028
## TODO:
1129
- [X] msgbox
1230
- [X] yesno
@@ -16,7 +34,7 @@ As we all know, premature optimization is the root of all evil, so this will be
1634
- [X] checklist
1735
- [X] radiolist
1836
- [X] gauge
19-
- [ ] help page
37+
- [X] help
2038
- [ ] man page
2139

2240
## Thanks:

help/help.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,23 @@ func Error(msg string) {
5454
func Help() {
5555
fmt.Print("\033[1;38;2;254;228;208mBox options:\n")
5656
fmt.Print("\n")
57-
fmt.Print(" --msgbox [options] <text> <height> <width>\n")
58-
fmt.Print(" --yesno [options] <text> <height> <width>\n")
59-
fmt.Print(" --infobox [options] <text> <height> <width>\n")
60-
fmt.Print(" --inputbox [options] <text> <height> <width> [init]\n")
61-
fmt.Print(" --passwordbox [options] <text> <height> <width>\n")
62-
fmt.Print(" --menu [options] <text> <height> <width> <listheight> [tag item] ...\n")
63-
fmt.Print(" --checklist [options] <text> <height> <width> <listheight> [tag item status]...\n")
64-
fmt.Print(" --radiolist [options] <text> <height> <width> <listheight> [tag item status]...\n")
65-
fmt.Print(" --gauge [options] <text> <height> <width>\n")
57+
fmt.Print(" --msgbox [options] <text> <height> <width>\n")
58+
fmt.Print(" --yesno [options] <text> <height> <width>\n")
59+
fmt.Print(" --infobox [options] <text> <height> <width>\n")
60+
fmt.Print(" --inputbox [options] <text> <height> <width> [init]\n")
61+
fmt.Print(" --passwordbox [options] <text> <height> <width>\n")
62+
fmt.Print(" --menu [options] <text> <height> <width> <listheight> [tag item] ...\n")
63+
fmt.Print(" --checklist [options] <text> <height> <width> <listheight> [tag item status]...\n")
64+
fmt.Print(" --radiolist [options] <text> <height> <width> <listheight> [tag item status]...\n")
65+
fmt.Print(" --gauge [options] <text> <height> <width>\n")
6666
fmt.Print("\n")
6767
fmt.Print("Options:\n")
6868
fmt.Print("\n")
6969
//fmt.Print(" --bgcolor\n")
7070
//fmt.Print(" --boxcolor\n")
7171
//fmt.Print(" --cursorcolor\n")
72-
fmt.Print(" --border [rounded/normal/thick/double/hidden]\n")
73-
fmt.Print("--help print this message\n")
74-
fmt.Print("--version print version information\033[0m\n")
72+
fmt.Print(" --border [rounded/normal/thick/double/hidden]\n")
73+
fmt.Print(" --help print this message\n")
74+
fmt.Print(" --version print version information\033[0m\n")
7575

7676
}

0 commit comments

Comments
 (0)