summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2010-10-08 09:41:19 -0400
committerKenneth Reitz <me@kennethreitz.com>2010-10-08 09:41:19 -0400
commitbe7182aea958520a9a2c37ae05130c88119f4e8d (patch)
tree926773f555bb59954dca3ec2d7c3f85d6b10b2c8 /docs
parent48def2cba6a9125b32b4455374297b7160507f37 (diff)
downloadtablib-be7182aea958520a9a2c37ae05130c88119f4e8d.tar.gz
installation documentation update.
Diffstat (limited to 'docs')
-rw-r--r--docs/install.rst33
1 files changed, 27 insertions, 6 deletions
diff --git a/docs/install.rst b/docs/install.rst
index 4801eee..ac6caf1 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -11,7 +11,31 @@ important right here and provide links to the canonical documentation.
Installing Tablib
-----------------
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+To install Tablib, it only takes one simple command. ::
+
+ $ pip install tablib
+
+Or, if you must: ::
+
+ $ easy_install tablib
+
+But, you really shouldn't do that.
+
+Speed Extentions
+----------------
+
+Tablib is partially dependent on the **pyyaml**, **simplejson**, and **xlwt** modules. To reduce installation issues, fully integrated versions of all required libraries are included in Tablib.
+
+However, if performance is important to you (and it should be), you should install **simplejson** and **pyyaml** with C extentions from PyPi. ::
+
+ $ pip install PyYAML
+
+If you're using Python 2.6+, the built-in **json** module is already optimized and in use. If you're using Python 2.5 (currently unsupported), you should also install the **simplejson** module. ::
+
+ $ pip install simplejson
+
+.. If you're using a Python < 2.6, you can speed up JSON
+
Pythons Supported
-----------------
@@ -21,13 +45,9 @@ At this time, only the following Python platforms are officially supported:
* Python 2.6
* Python 2.7
-Other Pythons will be supported soon.
+Support for other Pythons will be rolled out soon.
-C Extentions
-------------
-
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Virtualenv
@@ -35,6 +55,7 @@ Virtualenv
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
Staying Updated
---------------