diff options
Diffstat (limited to 'README.mkd')
| -rw-r--r-- | README.mkd | 52 |
1 files changed, 13 insertions, 39 deletions
@@ -5,8 +5,9 @@ __mitmdump__ is the command-line version of mitmproxy. Think tcpdump for HTTP. __libmproxy__ is the library that mitmproxy and mitmdump are built on. -Complete documentation and a set of practical tutorials is included in the -distribution package, and is also available at +Documentation, tutorials and distribution packages can be found on the +mitmproxy.org website: + [mitmproxy.org](http://mitmproxy.org). @@ -23,55 +24,28 @@ Features - SSL certificates for interception are generated on the fly. - And much, much more. -Download --------- - -Releases and documentation can be found on the mitmproxy website: - -[mitmproxy.org](http://mitmproxy.org) - -Source is hosted on github: - -[github.com/cortesi/mitmproxy](http://github.com/cortesi/mitmproxy) - - -Community ---------- - -Come join us in the #mitmproxy channel on the OFTC IRC network -(irc://irc.oftc.net:6667). - -We also have a mailing list, hosted here: - -[groups.google.com/group/mitmproxy](http://groups.google.com/group/mitmproxy) - Requirements ------------ * [Python](http://www.python.org) 2.7.x. +* [netlib](http://pypi.python.org/pypi/netlib), version matching mitmproxy. * [PyOpenSSL](http://pypi.python.org/pypi/pyOpenSSL) 0.13 or newer. * [pyasn1](http://pypi.python.org/pypi/pyasn1) 0.1.2 or newer. * [urwid](http://excess.org/urwid/) version 1.1 or newer. * [PIL](http://www.pythonware.com/products/pil/) version 1.1 or newer. * [lxml](http://lxml.de/) version 2.3 or newer. -* [netlib](http://pypi.python.org/pypi/netlib) 0.2.2 or newer. -The following auxiliary components may be needed if you plan to hack on -mitmproxy: +__mitmproxy__ is tested and developed on OSX, Linux and OpenBSD. Windows is not +officially supported at the moment. -* The test suite uses the [nose](http://readthedocs.org/docs/nose/en/latest/) unit testing - framework and requires [human_curl](https://github.com/Lispython/human_curl) and - [pathod](http://pathod.org). -* Rendering the documentation requires [countershape](http://github.com/cortesi/countershape). -__mitmproxy__ is tested and developed on OSX, Linux and OpenBSD. Windows is not -supported at the moment. +Hacking +------- + +The following components are needed if you plan to hack on mitmproxy: -You should also make sure that your console environment is set up with the -following: +* The test suite uses the [nose](http://readthedocs.org/docs/nose/en/latest/) unit testing + framework and requires [pathod](http://pathod.org) and [flask](http://flask.pocoo.org/). +* Rendering the documentation requires [countershape](http://github.com/cortesi/countershape). -* EDITOR environment variable to determine the external editor. -* PAGER environment variable to determine the external pager. -* Appropriate entries in your mailcap files to determine external - viewers for request and response contents. |