From ddda9a1521f944220f4af46d4f78a4dd02446cbf Mon Sep 17 00:00:00 2001 From: Chris Date: Mon, 1 Jun 2015 22:33:10 -0400 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d380900..1bc8aba 100644 --- a/README.md +++ b/README.md @@ -220,18 +220,10 @@ Want to add another one? Submit a [pull request!](https://github.com/chriskiehl/ - - - - - - ------------------------------------------- - - Configuration ------------- @@ -254,20 +246,36 @@ Just about everything in Gooey can be customized by passing arguments to the dec Run Modes --------- -Gooey has three main run modes +Gooey has a handful of presentation modes so you can tailor its layout to your content type and user's level or experience. -- Full/Advanced -- Basic -- No config +###Advanced + + + + +The default view is the "full" or "advanced" configuration screen. It comes in two different modes depending on the type of command line interface it's wrapping. For most applications, the flat layout will be the one to go with, as its layout matches best to the familiar CLI schema of a primary command followed by many options (e.g. Curl, FFMPEG). + +On the other side is the Column Layout. This is best suited for CLIs that have multiple paths or are made up of multiple tools (think: git). It displays the primary paths along the left column, and their corresponding arguments in the right. + +

+ +

+ +**Setting the layout style:** + +Currently, the layouts can't be explicitely specified via a parameter. The layouts are built depending on whether or not there are `subparsers` used in your code base. So, if you want to trigger the `Column Layout`, you'll need to add a `subparser` to your `argparse` code. + -###Advanced -The default view is the "full" or "advanced" configuration screen. It can be toggled via the `advanced` parameter in the `Gooey` decorator. + + + +It can be toggled via the `advanced` parameter in the `Gooey` decorator. @@ -278,9 +286,7 @@ The default view is the "full" or "advanced" configuration screen. It can be tog This view presents each action in the `Argument Parser` as a unique GUI component. This view is ideal for presenting the program to users which are unfamiliar with command line options and/or Console Programs in general. Help messages are displayed along side each component to make it as clear as possible which each widget does. -

- -

+ --------------------------------------------