]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - docs/quickstart.rst
update docs for 1.10.2 release
[tahoe-lafs/tahoe-lafs.git] / docs / quickstart.rst
index bfc7129a9b47141bfc847ba606c701dd58d20b34..d7161123b079d98c6b9a6cd18d6ad09cbd5ff1a5 100644 (file)
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature-unix; fill-column: 77 -*-
+
 ==================
 Getting Tahoe-LAFS
 ==================
@@ -14,8 +15,7 @@ How To Get Tahoe-LAFS
 =====================
 
 This procedure has been verified to work on Windows, Mac, OpenSolaris, and
-too many flavors of Linux and of BSD to list. It's likely to work on other
-platforms.
+too many flavors of Linux and of BSD to list.
 
 In Case Of Trouble
 ------------------
@@ -31,28 +31,29 @@ Install Python
 --------------
 
 Check if you already have an adequate version of Python installed by running
-``python -V``. Python v2.6 (v2.6.6 or greater recommended) or Python v2.7 will
-work. Python v3 does not work. On Windows, we recommend the use of native
-Python v2.7, not Cygwin Python. If you don't have one of these versions of
-Python installed, download and install `Python v2.7`_. Make sure that the path
-to the installation directory has no spaces in it (e.g. on Windows, do not
-install Python in the "Program Files" directory).
+``python -V``. Python v2.6 (v2.6.6 or greater recommended) or Python v2.7
+will work. Python v3 does not work. On Windows, we recommend the use of
+native Python v2.7, not Cygwin Python. If you don't have one of these
+versions of Python installed, `download`_ and install the latest version of
+Python v2.7. Make sure that the path to the installation directory has no
+spaces in it (e.g. on Windows, do not install Python in the "Program Files"
+directory).
 
-.. _Python v2.7: http://www.python.org/download/releases/2.7.4/
+.. _download: https://www.python.org/downloads/
 
 Get Tahoe-LAFS
 --------------
 
-Download the latest stable release, `Tahoe-LAFS v1.10.0`_.
+Download the latest stable release, `Tahoe-LAFS v1.10.2`_.
 
-.. _Tahoe-LAFS v1.10.0: https://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.10.0.zip
+.. _Tahoe-LAFS v1.10.2: https://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.10.2.zip
 
 Set Up Tahoe-LAFS
 -----------------
 
 Unpack the zip file and cd into the top-level directory.
 
-Run ``python setup.py build`` to generate the ``tahoe`` executable in a
+Run "``python setup.py build``" to generate the ``tahoe`` executable in a
 subdirectory of the current directory named ``bin``. This will download and
 build anything you need from various websites.
 
@@ -60,12 +61,17 @@ On Windows, the ``build`` step might tell you to open a new Command Prompt
 (or, on XP and earlier, to log out and back in again). This is needed the
 first time you set up Tahoe-LAFS on a particular installation of Windows.
 
-Run ``bin/tahoe --version`` (on Windows, ``bin\tahoe --version``) to verify
-that the executable tool prints out the right version number after
+If you see an error like ``fatal error: Python.h: No such file or directory``
+while compiling the dependencies, you need the Python development headers. If
+you are on a Debian or Ubuntu system, you can install them with ``sudo
+apt-get install python-dev``. On RedHat/Fedora, install ``python-devel``.
+
+Run "``bin/tahoe --version``" (on Windows, "``bin\tahoe --version``") to
+verify that the executable tool prints out the right version number after
 "``allmydata-tahoe:``".
 
-Optionally run ``python setup.py trial`` to verify that it passes all of its
-self-tests.
+Optionally run "``python setup.py trial``" to verify that it passes all of
+its self-tests.
 
 Run Tahoe-LAFS
 --------------