Skip to content

Commit

Permalink
Better docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ole108 committed Nov 22, 2024
1 parent db98725 commit 84069e8
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 10 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# fdialog - A new tool in the toolbox
# fdialog - Create Native GUIs With Ease



## Installation

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

## Usage



## Notes

The project has been scaffolded with the help of [kleiner](https://github.com/can3p/kleiner)
2 changes: 1 addition & 1 deletion cobracmd/compact.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ var compactCmd = &cobra.Command{
}

func init() {
rootCmd.AddCommand(compactCmd)
//rootCmd.AddCommand(compactCmd)
}
12 changes: 6 additions & 6 deletions cobracmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ var generateCmd = &cobra.Command{
}

func init() {
rootCmd.AddCommand(generateCmd)

generateCmd.Flags().StringVarP(&generateCmdData.format, "format", "t", "uidl",
"format of the GUI description (valid values are: json, go or uidl)")
generateCmd.Flags().StringVarP(&generateCmdData.dest, "dest", "d", ".",
"destination directory for the generated result files")
//rootCmd.AddCommand(generateCmd)
//
//generateCmd.Flags().StringVarP(&generateCmdData.format, "format", "t", "uidl",
// "format of the GUI description (valid values are: 'json' and 'uidl')")
//generateCmd.Flags().StringVarP(&generateCmdData.dest, "dest", "d", ".",
// "destination directory for the generated result files")
}
4 changes: 2 additions & 2 deletions cobracmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import (
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "fdialog",
Short: "A small tool for displaying GUIs",
Long: `A small tool for displaying GUIs`,
Short: "Create Native GUIs With Ease",
Long: "Create Native GUIs With Ease",
}

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

0 comments on commit 84069e8

Please sign in to comment.