diff --git a/README.md b/README.md index 20bd817..eb97d23 100644 --- a/README.md +++ b/README.md @@ -18,33 +18,33 @@ Table of Contents ----------------- - [Gooey](#gooey) - - [Table of Contents](#table-of-contents) - - [Quick Start](#quick-start) - - [Installation instructions](#installation-instructions) +- [Table of contents](#table-of-contents) +- [Latest Update](#latest-update) +- [Quick Start](#quick-start) + - [Installation Instructions](#installation-instructions) - [Usage](#usage) - [Examples](#examples) - - [What is it?](#what-is-it) - - [Why?](#why) - - [Who is this for?](#who-is-this-for) - - [How does it work?](#how-does-it-work) - - [Mappings:](#mappings) - - [GooeyParser](#gooeyparser) - - [Internationalization](#internationalization) - - [Global Configuration](#global-configuration) - - [Layout Customization](#layout-customization) - - [Run Modes](#run-modes) - - [Advanced](#advanced) +- [What It Is](#what-is-it) +- [Why Is It](#why) +- [Who is this for](#who-is-this-for) +- [How does it work](#how-does-it-work) +- [Internationalization](#internationalization) +- [Global Configuration](#global-configuration) +- [Layout Customization](#layout-customization) +- [Run Modes](#run-modes) + - [Full/Advanced](#advanced) - [Basic](#basic) - [No Config](#no-config) - - [Menus](#menus) - - [Input Validation](#input-validation) - - [Using Dynamic Values](#using-dynamic-values) - - [Showing Progress](#showing-progress) +- [Menus](#menus) +- [Input Validation](#input-validation) +- [Using Dynamic Values](#using-dynamic-values) +- [Showing Progress](#showing-progress) - [Elapsed / Remaining Time](#elapsed--remaining-time) - - [Customizing Icons](#customizing-icons) - - [Packaging](#packaging) - - [Screenshots](#screenshots) - - [Wanna help?](#wanna-help) +- [Customizing Icons](#customizing-icons) +- [Packaging](#packaging) +- [Screenshots](#screenshots) +- [Contributing](#wanna-help) +- [Image Credits](#image-credits) @@ -157,16 +157,16 @@ At run-time, it parses your Python script for all references to `ArgumentParser` Gooey does its best to choose sensible defaults based on the options it finds. Currently, `ArgumentParser._actions` are mapped to the following `WX` components. -| Parser Action | Widget | Example | -| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| store | TextCtrl | | -| store_const | CheckBox | | -| store_true | CheckBox | | -| store_False | CheckBox | | -| append | TextCtrl | | -| count | DropDown | | -| Mutually Exclusive Group | RadioGroup | | -| choice | DropDown | | +| Parser Action | Widget | Example | +|:----------------------|-----------|------| +| store | TextCtrl | | +| store_const | CheckBox || +| store_true | CheckBox | | +| store_False | CheckBox| | +| append | TextCtrl | | +| count | DropDown | | +| Mutually Exclusive Group | RadioGroup | +|choice | DropDown | | ### GooeyParser @@ -200,14 +200,14 @@ However, by dropping in `GooeyParser` and supplying a `widget` name, you can dis **Custom Widgets:** -| Widget | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| DirChooser, FileChooser, MultiFileChooser, FileSaver, MultiFileSaver |
| -| DateChooser/TimeChooser |Please note that for both of these widgets the values passed to the application will always be in [ISO format](https://www.wxpython.org/Phoenix/docs/html/wx.DateTime.html#wx.DateTime.FormatISOTime) while localized values may appear in some parts of the GUI depending on end-user settings.
| -| PasswordField | | -| Listbox | ![image](https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/31590191-fadd06f2-b1c0-11e7-9a49-7cbf0c6d33d1.png) | -| BlockCheckbox | ![image](https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/46922288-9296f200-cfbb-11e8-8b0d-ddde08064247.png)Please note that for both of these widgets the values passed to the application will always be in [ISO format](https://www.wxpython.org/Phoenix/docs/html/wx.DateTime.html#wx.DateTime.FormatISOTime) while localized values may appear in some parts of the GUI depending on end-user settings.
| +| PasswordField | | +| Listbox | ![image](https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/31590191-fadd06f2-b1c0-11e7-9a49-7cbf0c6d33d1.png) | +| BlockCheckbox | ![image](https://github.com/chriskiehl/GooeyImages/raw/images/readme-images/46922288-9296f200-cfbb-11e8-8b0d-ddde08064247.png)