Skip to content

Commit 84069e8

Browse files
committed
Better docs.
1 parent db98725 commit 84069e8

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# fdialog - A new tool in the toolbox
1+
# fdialog - Create Native GUIs With Ease
2+
3+
24

35
## Installation
46

@@ -28,6 +30,10 @@ The script will install the binary into `$HOME/bin` folder by default, you can o
2830
Get the archive that fits your system from the [Releases](https://github.com/https://github.com/flowdev/fdialog/releases) page and
2931
extract the binary into a folder that is mentioned in your `$PATH` variable.
3032

33+
## Usage
34+
35+
36+
3137
## Notes
3238

3339
The project has been scaffolded with the help of [kleiner](https://github.com/can3p/kleiner)

cobracmd/compact.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ var compactCmd = &cobra.Command{
2020
}
2121

2222
func init() {
23-
rootCmd.AddCommand(compactCmd)
23+
//rootCmd.AddCommand(compactCmd)
2424
}

cobracmd/generate.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ var generateCmd = &cobra.Command{
2424
}
2525

2626
func init() {
27-
rootCmd.AddCommand(generateCmd)
28-
29-
generateCmd.Flags().StringVarP(&generateCmdData.format, "format", "t", "uidl",
30-
"format of the GUI description (valid values are: json, go or uidl)")
31-
generateCmd.Flags().StringVarP(&generateCmdData.dest, "dest", "d", ".",
32-
"destination directory for the generated result files")
27+
//rootCmd.AddCommand(generateCmd)
28+
//
29+
//generateCmd.Flags().StringVarP(&generateCmdData.format, "format", "t", "uidl",
30+
// "format of the GUI description (valid values are: 'json' and 'uidl')")
31+
//generateCmd.Flags().StringVarP(&generateCmdData.dest, "dest", "d", ".",
32+
// "destination directory for the generated result files")
3333
}

cobracmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import (
1212
// rootCmd represents the base command when called without any subcommands
1313
var rootCmd = &cobra.Command{
1414
Use: "fdialog",
15-
Short: "A small tool for displaying GUIs",
16-
Long: `A small tool for displaying GUIs`,
15+
Short: "Create Native GUIs With Ease",
16+
Long: "Create Native GUIs With Ease",
1717
}
1818

1919
// Execute adds all child commands to the root command and sets flags appropriately.

0 commit comments

Comments
 (0)