From: Zooko O'Whielacronx Date: Wed, 2 May 2007 05:34:33 +0000 (-0700) Subject: make big distinction between downloading precompiled packages and building yourself X-Git-Tag: allmydata-tahoe-0.2.0~18 X-Git-Url: https://git.rkrishnan.org/architecture.txt?a=commitdiff_plain;h=3b9aab45925a86c86900ebfa48d095407eb925ea;p=tahoe-lafs%2Ftahoe-lafs.git make big distinction between downloading precompiled packages and building yourself Both of my two test subjects here stumbled on this by thinking that building on debian was related to building debian packages was related to downloading precompiled packages. --- diff --git a/README b/README index 3fa74ef5..9fd8ab0f 100644 --- a/README +++ b/README @@ -9,8 +9,19 @@ The interface to the storage grid allows you to store and fetch files, either by self-authenticating cryptographic identifier or by filename and path. +LICENCE: + + Tahoe is offered under the GNU General Public License (v2 or later), with + the added permission that, if you become obligated to release a derived work + under this licence (as per section 2.b), you may delay the fulfillment of + 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: @@ -25,95 +36,81 @@ GETTING PRECOMPILED PACKAGES FOR DEBIAN-LIKE SYSTEMS: 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 + * getting the source code: - See http://allmydata.org for all kinds of information, news, and community - contributions. + The code is available via darcs by running the following command: + darcs get http://allmydata.org/source/tahoe/trunk -LICENCE: + See http://allmydata.org for all kinds of information, news, and community + contributions. - Tahoe is offered under the GNU General Public License (v2 or later), with - the added permission that, if you become obligated to release a derived work - under this licence (as per section 2.b), you may delay the fulfillment of - this obligation for up to 12 months. See the COPYING file for details. + * 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. -DEPENDENCIES: + For example, on an debian-like system, you can do "sudo apt-get install + gcc make python-dev python-twisted python-nevow python-pyopenssl". - 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. If you are running any modern Linux or *BSD distribution, - then you can get them through your standard package manager. If you are - running Mac OS X, then be warned that the "fink" package management tool - does not have most of these packages, but the "darwinports" package - management tool appears to have them. If you are running on Windows, then - I'm afraid you'll have to install them by hand (although the "cygwin" - package management tool does have some of them). If you are running on - Solaris, I would like to hear from you -- I have no idea how it is done on - Solaris nowadays. + + 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. - http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions + http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions - 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. + + 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 + + build-essential and fakeroot: only required to build .deb packages - * to build the debian packages you will need all the usual debian-packaging - tools, which means the 'build-essential' metapackage and all of the - packages listed as "Build-Depends" in DIST/debian/control for your - distribution. You will also want the 'fakeroot' package to allow the - top-level 'make deb-DIST' targets work. + Also all of the packages listed as "Build-Depends" in + DIST/debian/control for your distribution. - * on Windows, the pywin32 package + You can do "apt-get install build-essential fakeroot" - http://sourceforge.net/projects/pywin32/ + + the pywin32 package: only required on Windows - On debian systems, these dependencies can be handled by installing the - following packages: build-essential, python-dev, python-twisted, - python-nevow, python-setuptools, python-pyopenssl, fakeroot. + http://sourceforge.net/projects/pywin32/ BUILDING: