From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Mon, 30 Apr 2007 05:16:33 +0000 (-0700)
Subject: large update to the install instructions in the README, and add a link to allmydata.org
X-Git-Tag: allmydata-tahoe-0.2.0~69
X-Git-Url: https://git.rkrishnan.org/schema.xhtml?a=commitdiff_plain;h=3538693aa5ec3eec472f6f56c502336a67698fbf;p=tahoe-lafs%2Ftahoe-lafs.git

large update to the install instructions in the README, and add a link to allmydata.org
---

diff --git a/README b/README
index 2a31bf30..e6a463b9 100644
--- a/README
+++ b/README
@@ -9,6 +9,16 @@ The interface to the storage mesh allows you to store and fetch files, either
 by self-authenticating cryptographic identifier or by filename and path.
 
 
+GETTING THE SOURCE CODE:
+
+ The code is available via darcs by running the following command:
+
+ darcs get http://allmydata.org/source/tahoe/trunk
+
+ See http://allmydata.org for all kinds of information, news, and community
+ contributions.
+
+
 LICENCE:
 
  Tahoe is offered under the GNU General Public License (v2 or later), with
@@ -95,40 +105,47 @@ BUILDING:
 
 INSTALLING:
 
- If you're running on a debian system, use 'make deb-dapper' or 'make
- deb-sid' to construct a debian package named 'allmydata-tahoe', which you
- can then install.
+ The Debian Way:
+
+  If you're running on a debian system, use 'make deb-dapper', 'make
+  deb-sid', 'make deb-edgy', or 'make deb-feisty' to construct a debian
+  package named 'allmydata-tahoe', which you can then install.
+
+ 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
+  "--root=/usr/local/stow/${PACKAGE}" to the "setup.py install" command.
 
- If not, you'll need to run four separate install steps, one for each of the
- four subpackages (allmydata, allmydata.Crypto, foolscap, and zfec). You may
- wish to use a different version of 'python' for these steps, or provide a
- --prefix or --root argument for the install.
+   for PACKAGE in zfec Crypto foolscap ; do
+     cd src/${PACKAGE} && python setup.py install && cd ../..
+   done
 
-  cd src/zfec && python setup.py install && cd ../..
+   # the tahoe subpackage's setup.py script is in the root directory
+   PACKAGE=tahoe
+   python setup.py install
 
-  cd src/Crypto && python setup.py install && cd ../..
+ The Running-In-Place Way:
 
-  cd src/foolscap && python setup.py install && cd ../..
+  To run from a source tree (without installing first), type 'make', which
+  will put all the necessary libraries into a local directory named
+  "./instdir/", which you can then add to your PYTHONPATH .
 
-  # the allmydata subpackage's setup.py script is in the root directory
-  python setup.py install
 
- To test that all the modules got installed properly, start a python
- interpreter and import modules as follows:
+ To Test That It Is Properly 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
-  >>>
+  To test that all the modules got installed properly, start a python
+  interpreter and import modules as follows:
 
- To run from a source tree (without installing first), type 'make', which
- will put all the necessary libraries into a local directory named
- "./instdir/", which you can then add to your PYTHONPATH .
+   % 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: