From b3eb6c8d2fc648245340fc4de7a9d96eb7176865 Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 2 Jun 2015 20:26:14 -0400 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 1bc8aba..4b8d4b9 100644 --- a/README.md +++ b/README.md @@ -256,37 +256,28 @@ Gooey has a handful of presentation modes so you can tailor its layout to your c -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). +The default view is the "full" or "advanced" configuration screen. It has two different layouts 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. +On the other side is the Column Layout. This one is best suited for CLIs that have multiple paths or are made up of multiple little tools each with their own arguments and options (think: git). It displays the primary paths along the left column, and their corresponding arguments in the right. This is a great way to package a lot of varied functionality into a single app.

-**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. - - - - - +Both views present each action in the `Argument Parser` as a unique GUI component. It makes it 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. +**Setting the layout style:** +Currently, the layouts can't be explicitely specified via a parameter (on the TODO!). 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. It can be toggled via the `advanced` parameter in the `Gooey` decorator. - @gooey(advanced=True) def main(): # rest of code - -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. - -------------------------------------------- @@ -321,7 +312,7 @@ No Config pretty much does what you'd expect: it doesn't show a configuration sc Examples -------- -Examples are located in the `examples` directory inside of the root `gooey` package. However, the easiest way to play with them is to import them into a python project and execute their `main` function. +Gooey comes with a bunch of example programs. Examples are located in the `examples` directory inside of the root `gooey` package. However, the easiest way to play with them is to import them into a python project and execute their `main` function. from gooey.examples import widget_demo widget_demo.main() @@ -336,9 +327,12 @@ or Screenshots ------------ -

- -

+ +| Flat Layout | Column Layout |Success Screen | Error Screen | Warning Dialog | +|-------------|---------------|---------------|--------------|----------------| +| | | | | | + + ---------------------------------------------- @@ -357,13 +351,6 @@ Screenshots - Fixed issue #85 - Argparse no longer required to me in `main` (issue 84) - Drag and Drop support (`Issue #28`) - -

- -

- -Tada! - - Added drag and drop support - Added new widget packs: DateChooser, FileChooser, DirChooser - fixed several parsing related issues.