From f47d89ff4e710f6d2df755fe526e91a5cf236cfa Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Mon, 27 Jan 2014 14:16:23 +1300
Subject: Revert "Move the doc tree out into its own repo."

This reverts commit 8f88fcedd601c0033b4469b66626a83011879baf.
---
 doc-src/install.html | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 doc-src/install.html

(limited to 'doc-src/install.html')

diff --git a/doc-src/install.html b/doc-src/install.html
new file mode 100644
index 00000000..70003d60
--- /dev/null
+++ b/doc-src/install.html
@@ -0,0 +1,52 @@
+
+The preferred way to install mitmproxy - whether you're installing the latest
+release or from source - is to use [pip](http://www.pip-installer.org/). If you
+don't already have pip on your system, you can find installation instructions
+[here](http://www.pip-installer.org/en/latest/installing.html).
+
+
+## Installing the latest release
+
+A single command will download and install the latest release of mitmproxy,
+along with all its dependencies:
+
+<pre class="terminal">
+pip install mitmproxy
+</pre>
+
+
+## Installing from source
+
+When installing from source, the easiest method is still to use pip. In this
+case run:
+    
+<pre class="terminal">
+pip install /path/to/source
+</pre>
+
+Note that if you're installing current git master, you will also have to
+install the current git master of [netlib](http://github.com/mitmproxy/netlib) by
+hand.
+
+## OSX
+
+- If you're running a Python interpreter installed with homebrew (or similar),
+you may have to install some dependencies by hand. 
+- Make sure that XCode is installed from the App Store, and that the
+command-line tools have been downloaded (XCode/Preferences/Downloads).
+- Now use __pip__ to do the installation, as above.
+
+There are a few bits of customization you might want to do to make mitmproxy
+comfortable to use on OSX. The default color scheme is optimized for a dark
+background terminal, but you can select a palette for a light terminal
+background with the --palette option. You can use the OSX <b>open</b> program
+to create a simple and effective <b>~/.mailcap</b> file to view request and
+response bodies:
+
+<pre class="terminal">
+application/*; /usr/bin/open -Wn %s
+audio/*; /usr/bin/open -Wn %s
+image/*; /usr/bin/open -Wn %s
+video/*; /usr/bin/open -Wn %s
+</pre>
+
-- 
cgit v1.2.3