Browse Source

Merge branch 'master' of https://github.com/chriskiehl/Gooey

pull/6/head
chriskiehl 10 years ago
parent
commit
f49edbd38c
1 changed files with 20 additions and 12 deletions
  1. 32
      README.md

32
README.md

@ -3,11 +3,19 @@ Gooey (Beta)
Turn (almost) any Console Program into a GUI application with one line
<p align="center">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/primary.png"/>
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/primary.png"/>
</p>
**Update**
----------
Whoops. Looks like I packaged it up wrong with distutils(first time doing it!), so after install the program is missing the language and image files. You can remedy this by manually copying `/images` and `/languages` from the repo into `/site-packages/gooey`. I'll have this fixed in a second.
Table of Contents
-----------------
@ -98,13 +106,13 @@ Currently, the `ArgumentParser._actions` are mapped to the following `WX` compon
| Parser Action | Widget | Example |
|:----------------------|-----------|------|
| store | TextCtrl | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/general_tb.png"/>|
| store_const | CheckBox | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/check_box.png"/>|
| store_true| CheckBox | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/check_box.png"/>|
| store_False | CheckBox| <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/check_box.png"/> |
| append | TextCtrl | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/general_tb.png"/> |
| count| DropDown &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/count_dropdown.png"/> |
|choice &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| DropDown | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/options_dropdown.png"/> |
| store | TextCtrl | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/general_tb.png"/>|
| store_const | CheckBox | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/check_box.png"/>|
| store_true| CheckBox | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/check_box.png"/>|
| store_False | CheckBox| <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/check_box.png"/> |
| append | TextCtrl | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/general_tb.png"/> |
| count| DropDown &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/count_dropdown.png"/> |
|choice &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| DropDown | <img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/options_dropdown.png"/> |
-------------------------------------------
@ -149,7 +157,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.
<p align="center">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/advanced_config.png">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/advanced_config.png">
</p>
--------------------------------------------
@ -165,7 +173,7 @@ The basic view is best for times when the user is familiar with Console Applicat
# rest of code
<p align="center">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/basic_config.png">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/basic_config.png">
</p>
@ -176,7 +184,7 @@ The basic view is best for times when the user is familiar with Console Applicat
No Config pretty much does what you'd expect: it doesn't show a configuration screen. It hops right to the `display` section and begins execution of the host program. This is the guy for classing up the delivery of little one-off scripts.
<p align="center">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/no_config.png">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/no_config.png">
</p>
---------------------------------------
@ -184,7 +192,7 @@ No Config pretty much does what you'd expect: it doesn't show a configuration sc
Final Screen
------------
<p align="center">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/readme_images/final_screen.png">
<img src="https://raw.githubusercontent.com/chriskiehl/Gooey/master/resources/final_screen.png">
</p>
----------------------------------------------

Loading…
Cancel
Save