]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/commitdiff
re-re-factored the download and install instructions
authorZooko O'Whielacronx <zooko@zooko.com>
Wed, 2 May 2007 19:54:26 +0000 (12:54 -0700)
committerZooko O'Whielacronx <zooko@zooko.com>
Wed, 2 May 2007 19:54:26 +0000 (12:54 -0700)
Now the instructions about how to download debian packages live on a separate
page of the wiki instead of on the front page or in the README.  The README is
only about building from source.  The front page contains pointers to those two
other pages (the debiandownloadpage and the README).

README
setup.py

diff --git a/README b/README
index f2b5dcb9e5b709337d80a634160652550e2563a5..86fc435e1fcb8e8670beed507f6e3706b12d4a87 100644 (file)
--- a/README
+++ b/README
@@ -8,6 +8,11 @@ majority of the nodes are no longer available.
 The interface to the storage grid allows you to store and fetch files, either
 by self-authenticating cryptographic identifier or by filename and path.
 
+See the web site for all kinds of information, news, and community
+contributions, including prebuilt packages for Debian-like systems:
+
+http://allmydata.org
+
 
 LICENCE:
 
@@ -17,93 +22,74 @@ LICENCE:
  this obligation for up to 12 months.  See the COPYING file for details.
 
 
-GETTING PRECOMPILED PACKAGES FOR DEBIAN-LIKE SYSTEMS:
-
- At this time, precompiled packages are available only for Debian-like
- systems.
-
- To install debian packages for etch, dapper, edgy, or feisty, add the
- following lines to your /etc/apt/sources.list, replacing the word DIST with
- etch, dapper, edgy, or feisty as appropriate:
-
-  deb http://allmydata.org/debian/  DIST  main tahoe
-  deb-src http://allmydata.org/debian/  DIST  main tahoe
-
- Then update and install the allmydata-tahoe package.  These packages are
- generated each time the code is changed, and represent the most up-to-date
- (read "unstable") version available.  The usual warnings about no guarantees
- apply: it might cause your computer to catch fire, might steal your dog,
- etc.
+GETTING THE SOURCE CODE:
 
+The code is available via darcs by running the following command:
 
-BUILDING FROM SOURCE:
+darcs get http://allmydata.org/source/tahoe/trunk tahoe
 
- * getting the source code:
+Tarballs of sources are available at:
 
-   The code is available via darcs by running the following command:
+http://allmydata.org/source/tahoe/
 
-   darcs get http://allmydata.org/source/tahoe/trunk tahoe
 
-   See http://allmydata.org for all kinds of information, news, and community
-   contributions.
+DEPENDENCIES:
 
- * dependencies:
+Note: All of the following dependencies can probably be installed through
+your standard package management tool if you are running on a modern Unix
+operating system.
 
-   Note: All of the following dependencies can probably be installed through
-   your standard package management tool if you are running on a modern Unix
-   operating system.
+For example, on an debian-like system, you can do "sudo apt-get install
+gcc make python-dev python-twisted python-nevow python-pyopenssl".
 
-   For example, on an debian-like system, you can do "sudo apt-get install
-   gcc make python-dev python-twisted python-nevow python-pyopenssl".
+ + a C compiler (language)
 
   + a C compiler (language)
+ GNU make (build tool)
 
-    + GNU make (build tool)
+ + Python 2.4 or newer (tested against 2.4, and 2.5.1, but v2.5 or higher
+   is required on Windows-native), including development headers (language)
 
-    + Python 2.4 or newer (tested against 2.4, and 2.5.1, but v2.5 or higher
-      is required on Windows-native), including development headers (language)
+   http://python.org/
 
-      http://python.org/
+ + Python Twisted (tested against both 2.4 and 2.5) (network and operating
+   system integration library)
 
-    + Python Twisted (tested against both 2.4 and 2.5) (network and operating
-      system integration library)
+   http://twistedmatrix.com/
 
-      http://twistedmatrix.com/
+   You need the following subpackages, which are included in the default
+   Twisted distribution:
 
-      You need the following subpackages, which are included in the default
-      Twisted distribution:
+   * core (the standard Twisted package)
+   * web, trial, conch
 
-      * core (the standard Twisted package)
-      * web, trial, conch
+   Twisted requires zope.interface, a copy of which is included in the
+   Twisted distribution.
 
-      Twisted requires zope.interface, a copy of which is included in the
-      Twisted distribution.
+ + Python Nevow (probably 0.9.0 or later) (web presentation language)
 
-    + Python Nevow (probably 0.9.0 or later) (web presentation language)
+   http://divmod.org/trac/wiki/DivmodNevow
 
-      http://divmod.org/trac/wiki/DivmodNevow
+ + Python setuptools (build and distribution tool)
 
-    + Python setuptools (build and distribution tool)
+   Note: The build process will automatically download and install
+   setuptools if it is not present.  However, if an old, incompatible
+   version of setuptools (< v0.6c3) is present, then the build will fail.
+   Therefore, if the build fails due to setuptools not being compatible,
+   you can either upgrade or uninstall your version of setuptools and try
+   again.
 
-      Note: The build process will automatically download and install
-      setuptools if it is not present.  However, if an old, incompatible
-      version of setuptools (< v0.6c3) is present, then the build will fail.
-      Therefore, if the build fails due to setuptools not being compatible,
-      you can either upgrade or uninstall your version of setuptools and try
-      again.
+   http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions
 
-      http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions
+ + Python PyOpenSSL (0.6 or later) (secure transport layer)
 
-    + Python PyOpenSSL (0.6 or later) (secure transport layer)
+   http://pyopenssl.sourceforge.net
 
-      http://pyopenssl.sourceforge.net
+   To install PyOpenSSL on Windows-native, download this:
+   http://allmydata.org/source/pyOpenSSL-0.6.win32-py2.5.exe
 
-      To install PyOpenSSL on Windows-native, download this:
-      http://allmydata.org/source/pyOpenSSL-0.6.win32-py2.5.exe
+ + the pywin32 package: only required on Windows
 
-    + the pywin32 package: only required on Windows
-
-      http://sourceforge.net/projects/pywin32/
+   http://sourceforge.net/projects/pywin32/
 
 
 BUILDING:
@@ -124,8 +110,13 @@ BUILDING:
 
 INSTALLING:
 
+There are three ways to do it.  Choose one:
+
  The Debian Way:
 
+  The Debian Way is to build .deb files which you can then install with
+  "dpkg".
+
   This requires the debian packages build-essential, fakeroot, devscripts,
   and the packages listed as "Build-Depends" in the DIST/debian/control in
   the top-level tahoe directory, replacing the word DIST with etch, dapper,
@@ -139,21 +130,25 @@ INSTALLING:
 
  The Python Way:
 
-  You'll need to run four separate install steps, one for each of the four
-  subpackages (allmydata, allmydata.Crypto, foolscap, and zfec).  If you use
-  GNU stow, add the options "--prefix=." and
+  The Python Way is to execute "setup.py install" for each Python package.
+
+  You'll need to run "setup.py install" four separate times, one for each of
+  the four subpackages (allmydata, allmydata.Crypto, foolscap, and zfec).  If
+  you use GNU stow, add the options "--prefix=." and
   "--root=/usr/local/stow/${PACKAGE}" to the "setup.py install" command.
 
-   for PACKAGE in zfec Crypto foolscap ; do
-     cd src/${PACKAGE} && python setup.py install && cd ../..
-   done
+    for PACKAGE in zfec Crypto foolscap ; do
+      cd src/${PACKAGE} && python setup.py install && cd ../..
+    done
 
-   # the tahoe subpackage's setup.py script is in the root directory
-   PACKAGE=tahoe
-   python setup.py install
+    # the tahoe subpackage's setup.py script is in the root directory
+    PACKAGE=tahoe
+    python setup.py install
 
  The Running-In-Place Way:
 
+  The Running-In-Place Way is to add a directory to your PYTHONPATH.
+
   To run from a source tree (without installing first), type 'make', which
   will put all the necessary libraries into a local directory named
   "./instdir/lib", which you can then add to your PYTHONPATH .  (It will put
@@ -163,16 +158,17 @@ INSTALLING:
 TESTING THAT IT IS PROPERLY INSTALLED
 
  To test that all the modules got installed properly, start a python
- interpreter and import modules as follows:
-
-  % python
-  Python 2.4.4 (#2, Jan 13 2007, 17:50:26)
-  [GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)] on linux2
-  Type "help", "copyright", "credits" or "license" for more information.
-  >>> import zfec
-  >>> import allmydata.Crypto
-  >>> import foolscap
-  >>> import allmydata.interfaces
+ interpreter and import modules as follows.  If each one imports successfully
+ instead of raising ImportError then it is correctly installed.
+
+   % python
+   Python 2.4.4 (#2, Jan 13 2007, 17:50:26)
+   [GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)] on linux2
+   Type "help", "copyright", "credits" or "license" for more information.
+   >>> import zfec
+   >>> import allmydata.Crypto
+   >>> import foolscap
+   >>> import allmydata.interfaces
 
 
 RUNNING:
index c932a3df28b9d8aab5c64aa7d85e3714b308cb26..f2ab1913f11da176e1f1659b5a27f7ffbc994e16 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -30,6 +30,7 @@ trove_classifiers=[
     "Environment :: Console",
     "Environment :: Web Environment",
     "License :: OSI Approved :: GNU General Public License (GPL)", 
+    "License :: DFSG approved",
     "Intended Audience :: Developers", 
     "Intended Audience :: End Users/Desktop",
     "Intended Audience :: System Administrators",