]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Document the fact that tornado can be installed with pip/etc.
authorBen Darnell <ben@bendarnell.com>
Sun, 20 Feb 2011 20:49:53 +0000 (12:49 -0800)
committerBen Darnell <ben@bendarnell.com>
Sun, 20 Feb 2011 20:49:53 +0000 (12:49 -0800)
website/templates/documentation.txt
website/templates/index.html

index f0849256323e838575cddbe8678f88635f147ce4..129ce3488a3a25e6489603d452da21e310751158 100644 (file)
@@ -46,39 +46,27 @@ modules, so you should (theoretically) be able to use any of the modules
 independently in your project without using the whole package.
 
 
-Download
---------
-Download the most recent version of Tornado from GitHub:
-
-> [tornado-1.1.1.tar.gz](http://github.com/downloads/facebook/tornado/tornado-1.1.1.tar.gz)
-
-You can also [browse the source](http://github.com/facebook/tornado) on GitHub. To install Tornado:
-
-    tar xvzf tornado-1.1.1.tar.gz
-    cd tornado-1.1.1
-    python setup.py build
-    sudo python setup.py install
-
-After installation, you should be able to run any of the demos in the `demos`
-directory included with the Tornado package.
-
-    ./demos/helloworld/helloworld.py
-
-### Prerequisites
-
-Tornado has been tested on Python 2.5 and 2.6. To use all of the features of Tornado, you need to have [PycURL](http://pycurl.sourceforge.net/) (version 7.18.2 or higher) and (for Python 2.5 only) [simplejson](http://pypi.python.org/pypi/simplejson/) installed (Python 2.6 includes JSON support in the standard library so simplejson is not needed). Complete installation instructions for Mac OS X and Ubuntu are included below for convenience.
-
-**Mac OS X 10.6 (Python 2.6)**
-
-    sudo easy_install pycurl
-
-**Ubuntu Linux (Python 2.6)**
-
-    sudo apt-get install python-pycurl
-
-**Ubuntu Linux (Python 2.5)**
-
-    sudo apt-get install python-dev python-pycurl python-simplejson
+Download and install
+--------------------
+  <p><b>Automatic installation:</b> Tornado is listed in <a href="http://pypi.python.org/pypi/tornado">PyPI</a> and can be installed with <code>pip</code> or <code>easy_install</code>.  If you do not already have libcurl installed you may need to install it separately; see the prerequisites section below.  Note that the source distribution includes demo applications that are not present when Tornado is installed using <code>pip</code> or <code>easy_install</code></p>
+
+  <p><b>Manual installation:</b> Download <a href="http://github.com/downloads/facebook/tornado/tornado-1.1.1.tar.gz">tornado-1.1.1.tar.gz</a></p>
+  <pre><code>tar xvzf tornado-1.1.1.tar.gz
+cd tornado-1.1.1
+python setup.py build
+sudo python setup.py install</code></pre>
+  <p>The Tornado source code is <a href="http://github.com/facebook/tornado">hosted on GitHub</a>.  On Python 2.6+, it is also possible to simply add the tornado directory to your <code>PYTHONPATH</code> instead of building with <code>setup.py</code>, since the standard library includes <code>epoll</code> support.</p>
+
+  <h3>Prerequisites</h3>
+  <p>Tornado has been tested on Python 2.5, 2.6, and 2.7. To use all of the features of Tornado, you need to have <a href="http://pycurl.sourceforge.net/">PycURL</a> (version 7.18.2 or higher) and (for Python 2.5 only) <a href="http://pypi.python.org/pypi/simplejson/">simplejson</a> installed (Python 2.6 includes JSON support in the standard library so simplejson is not needed). Complete installation instructions for Mac OS X and Ubuntu are included below for convenience.</p>
+  <p style="font-weight:bold">Mac OS X 10.6 (Python 2.6+)</p>
+  <pre><code>sudo easy_install setuptools pycurl</code></pre>
+
+  <p style="font-weight:bold">Ubuntu Linux (Python 2.6+)</p>
+  <pre><code>sudo apt-get install python-pycurl</code></pre>
+
+  <p style="font-weight:bold">Ubuntu Linux (Python 2.5)</p>
+  <pre><code>sudo apt-get install python-dev python-pycurl python-simplejson</code></pre>
 
 
 Module index
index a409dade2386471859e072aacbde2d6045b9ed9d..ff003a489988214dd8548b44d3ea39286b2df7d6 100644 (file)
@@ -6,7 +6,9 @@
   <p>See the <a href="/documentation">Tornado documentation</a> for a detailed walkthrough of the framework.</p>
 
   <h2>Download and install</h2>
-  <p><b>Download:</b> <a href="http://github.com/downloads/facebook/tornado/tornado-1.1.1.tar.gz">tornado-1.1.1.tar.gz</a></p>
+  <p><b>Automatic installation:</b> Tornado is listed in <a href="http://pypi.python.org/pypi/tornado">PyPI</a> and can be installed with <code>pip</code> or <code>easy_install</code>.  If you do not already have libcurl installed you may need to install it separately; see the prerequisites section below.  Note that the source distribution includes demo applications that are not present when Tornado is installed using <code>pip</code> or <code>easy_install</code></p>
+
+  <p><b>Manual installation:</b> Download <a href="http://github.com/downloads/facebook/tornado/tornado-1.1.1.tar.gz">tornado-1.1.1.tar.gz</a></p>
   <pre><code>tar xvzf tornado-1.1.1.tar.gz
 cd tornado-1.1.1
 python setup.py build
@@ -14,11 +16,11 @@ sudo python setup.py install</code></pre>
   <p>The Tornado source code is <a href="http://github.com/facebook/tornado">hosted on GitHub</a>.  On Python 2.6+, it is also possible to simply add the tornado directory to your <code>PYTHONPATH</code> instead of building with <code>setup.py</code>, since the standard library includes <code>epoll</code> support.</p>
 
   <h3>Prerequisites</h3>
-  <p>Tornado has been tested on Python 2.5 and 2.6. To use all of the features of Tornado, you need to have <a href="http://pycurl.sourceforge.net/">PycURL</a> (version 7.18.2 or higher) and (for Python 2.5 only) <a href="http://pypi.python.org/pypi/simplejson/">simplejson</a> installed (Python 2.6 includes JSON support in the standard library so simplejson is not needed). Complete installation instructions for Mac OS X and Ubuntu are included below for convenience.</p>
-  <p style="font-weight:bold">Mac OS X 10.6 (Python 2.6)</p>
+  <p>Tornado has been tested on Python 2.5, 2.6, and 2.7. To use all of the features of Tornado, you need to have <a href="http://pycurl.sourceforge.net/">PycURL</a> (version 7.18.2 or higher) and (for Python 2.5 only) <a href="http://pypi.python.org/pypi/simplejson/">simplejson</a> installed (Python 2.6 includes JSON support in the standard library so simplejson is not needed). Complete installation instructions for Mac OS X and Ubuntu are included below for convenience.</p>
+  <p style="font-weight:bold">Mac OS X 10.6 (Python 2.6+)</p>
   <pre><code>sudo easy_install setuptools pycurl</code></pre>
 
-  <p style="font-weight:bold">Ubuntu Linux (Python 2.6)</p>
+  <p style="font-weight:bold">Ubuntu Linux (Python 2.6+)</p>
   <pre><code>sudo apt-get install python-pycurl</code></pre>
 
   <p style="font-weight:bold">Ubuntu Linux (Python 2.5)</p>