From 2fc0ce052a42ea65ebdfea240f42bb8885779010 Mon Sep 17 00:00:00 2001 From: Robert Klep Date: Sat, 12 Nov 2011 22:37:14 +0100 Subject: [PATCH] Added README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6bef5c --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# ToggleProxy + +_ToggleProxy_ is a [PyObjC][pyobjc]-based application for Mac OS X to +quickly enable and disable the HTTP proxy for the currently active +networking interface. + +It's a _headless_ application which installs a menu item in the Mac OS +X menu bar. The item shows either an up-arrow with a dashed line through it +(think _traffic is going through a proxy_) when the proxy is active, and +only an up-arrow when the proxy is not active. + +## Build + +To build the application, you'll have the Developer tools for Mac OS +X installed. + +When you have, you first build the application: + python setup.py py2app + +This builds the application as `dist/ToggleProxy.app`. You can run it from +there, or move it to somewhere more appropriate first.