From 85d5839bc0d6552c050781f5e84d2f0ee97e6da9 Mon Sep 17 00:00:00 2001 From: Chris Date: Sun, 31 May 2015 19:20:34 -0400 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dbd9459..39b536b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,8 @@ Table of Contents - [Full/Advanced](#advanced) - [Basic](#basic) - [No Config](#no-config) -- [Final Screen](#final-screen) +- [Examples](#examples) +- [Screenshots](#screenshots) - [Change Log](#change-log) - [TODO](#todo) - [Contributing](#wanna-help) @@ -310,7 +311,24 @@ No Config pretty much does what you'd expect: it doesn't show a configuration sc --------------------------------------- -Final Screen + +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. + + from gooey.examples import widget_demo + widget_demo.main() + +or + + from gooey.examples import subparser_demo + subparser_demo.main() + +>Note: The examples *must* be run from a Python file! Due to Gooey's file requirements, it won't work from the comman line. + + +Screenshots ------------