docs: update README, mv it to README.txt, update setup.py

diff --git a/README b/README
deleted file mode 100644 (file)
index 79b28dc..0000000
--- a/README
+++ /dev/null
@@ -1,14 +0,0 @@
-Welcome to the Tahoe-LAFS project--a secure, decentralized,
-fault-tolerant filesystem.  All of the source code is available under
-a Free Software, Open Source licence (or two).
-
-To get started please read
-
- * docs/install.html
- * docs/about.html
- * docs/running.html
-
-Finally, see docs/known_issues.txt for things that you need to know
-about if you are relying on Tahoe to store your valuable data.
-
-http://tahoe-lafs.org

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..d18eb6a
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,22 @@
+===============================
+Tahoe-LAFS
+===============================
+
+Tahoe-LAFS is a Free Software/Open Source decentralized data store. It
+distributes your filesystem across multiple servers, and even if some of the
+servers fail or are taken over by an attacker, the entire filesystem continues
+to work correctly and to preserve your privacy and security.
+
+To get started please see `quickstart.html`_.
+
+LICENCE
+=======
+
+You may use this package under the GNU General Public License, version 2 or, at your option, any later version.  You may use this package under the Transitive Grace Period Public Licence, version 1.0, or at your option, any later version. (You may choose to use this package under the terms of either licence, at your option.)  See the file `COPYING.GPL`_ for the terms of the GNU General Public License, version 2.  See the file `COPYING.TGPPL.html`_ for the terms of the Transitive Grace Period Public Licence, version 1.0.
+
+See `TGPPL.PDF`_ for why the TGPPL exists, graphically illustrated on three slides.
+
+.. _quickstart.html: http://allmydata.org/source/tahoe-lafs/trunk/docs/quickstart.html
+.. _COPYING.GPL: http://tahoe-lafs.org/trac/dupfilefind/browser/COPYING.GPL
+.. _COPYING.TGPPL.html: http://tahoe-lafs.org/source/dupfilefind/trunk/COPYING.TGPPL.html
+.. _TGPPL.PDF: http://tahoe-lafs.org/~zooko/tgppl.pdf

diff --git a/misc/debian/rules.sid b/misc/debian/rules.sid
index 7f12edf6e48102336a93ae67ea8c910387417c07..3b7bf2beb8a634f70cc0ce2a2c75c99d1499abc6 100644 (file)
--- a/misc/debian/rules.sid
+++ b/misc/debian/rules.sid
@@ -14,7 +14,7 @@ DEBNAME := $(firstword $(DEB_PACKAGES))
 
 STAGING_DIR := $(CURDIR)/debian/$(DEBNAME)
 
-DEB_INSTALL_DOCS_ALL := COPYING.TGPPL.html CREDITS NEWS README relnotes.txt \
+DEB_INSTALL_DOCS_ALL := COPYING.TGPPL.html CREDITS NEWS README.txt relnotes.txt \
  docs misc/spacetime misc/cpu-watcher.tac
 DEB_COMPRESS_EXCLUDE := .tac
 

diff --git a/misc/etch/debian/rules b/misc/etch/debian/rules
index f47024c6ab9871b7b7c1c845709c670d0000db6e..58f7bf29341637be710072edc023ea75e5d73879 100644 (file)
--- a/misc/etch/debian/rules
+++ b/misc/etch/debian/rules
@@ -15,7 +15,7 @@ DEBNAME := $(firstword $(DEB_PACKAGES))
 STAGING_DIR := $(CURDIR)/debian/$(DEBNAME)
 
 DEB_INSTALL_DOCS_ALL := COPYING.GPL COPYING.TGPPL.html CREDITS \
- NEWS README relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
+ NEWS README.txt relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
 DEB_COMPRESS_EXCLUDE := .tac
 
 

diff --git a/misc/lenny/debian/rules b/misc/lenny/debian/rules
index f47024c6ab9871b7b7c1c845709c670d0000db6e..58f7bf29341637be710072edc023ea75e5d73879 100644 (file)
--- a/misc/lenny/debian/rules
+++ b/misc/lenny/debian/rules
@@ -15,7 +15,7 @@ DEBNAME := $(firstword $(DEB_PACKAGES))
 STAGING_DIR := $(CURDIR)/debian/$(DEBNAME)
 
 DEB_INSTALL_DOCS_ALL := COPYING.GPL COPYING.TGPPL.html CREDITS \
- NEWS README relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
+ NEWS README.txt relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
 DEB_COMPRESS_EXCLUDE := .tac
 
 

diff --git a/misc/sid/debian/rules b/misc/sid/debian/rules
index f47024c6ab9871b7b7c1c845709c670d0000db6e..58f7bf29341637be710072edc023ea75e5d73879 100644 (file)
--- a/misc/sid/debian/rules
+++ b/misc/sid/debian/rules
@@ -15,7 +15,7 @@ DEBNAME := $(firstword $(DEB_PACKAGES))
 STAGING_DIR := $(CURDIR)/debian/$(DEBNAME)
 
 DEB_INSTALL_DOCS_ALL := COPYING.GPL COPYING.TGPPL.html CREDITS \
- NEWS README relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
+ NEWS README.txt relnotes.txt docs misc/spacetime misc/cpu-watcher.tac
 DEB_COMPRESS_EXCLUDE := .tac
 
 

diff --git a/setup.py b/setup.py
index 88536d125a5d4ce3f8d6a6b69a0a298197188a6b..b131188ab4a5b482a089b316f396dfcf0381059e 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,9 +1,9 @@
 #! /usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Allmydata Tahoe -- secure, distributed storage grid
+# Tahoe-LAFS -- secure, distributed storage grid
 #
-# Copyright © 2008-2009 Allmydata, Inc.
+# Copyright © 2008-2010 Allmydata, Inc.
 #
 # This file is part of Tahoe-LAFS.
 #
@@ -98,16 +98,6 @@ trove_classifiers=[
     ]
 
 
-LONG_DESCRIPTION=\
-"""Welcome to the Tahoe project, a secure, decentralized, fault-tolerant
-filesystem.  All of the source code is available under a Free Software, Open
-Source licence.
-
-This filesystem is encrypted and spread over multiple peers in such a way that
-it remains available even when some of the peers are unavailable,
-malfunctioning, or malicious."""
-
-
 setup_requires = []
 
 # The darcsver command from the darcsver plugin is needed to initialize the
@@ -359,11 +349,11 @@ if version:
 
 setup(name=APPNAME,
       description='secure, decentralized, fault-tolerant filesystem',
-      long_description=LONG_DESCRIPTION,
-      author='the allmydata.org Tahoe project',
+      long_description=open('README.txt', 'rU').read(),
+      author='the Tahoe-LAFS project',
       author_email='tahoe-dev@allmydata.org',
-      url='http://allmydata.org/',
-      license='GNU GPL',
+      url='http://tahoe-lafs.org/',
+      license='GNU GPL', # see README.txt -- there is an alternative licence
       cmdclass={"show_supportlib": ShowSupportLib,
                 "show_pythonpath": ShowPythonPath,
                 "run_with_pythonpath": RunWithPythonPath,