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

This commit is contained in:
Zooko O'Whielacronx 2010-05-04 02:43:40 -07:00
parent 43b092ffeb
commit 82b9b91775
7 changed files with 32 additions and 34 deletions

14
README
View File

@ -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

22
README.txt Normal file
View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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,