From: Daira Hopwood <daira@jacaranda.org>
Date: Tue, 9 Sep 2014 17:51:44 +0000 (+0100)
Subject: Rename README.txt to README.rst, and add Travis-CI and Coveralls badges to it.
X-Git-Tag: allmydata-tahoe-1.10.1a1~139
X-Git-Url: https://git.rkrishnan.org/quickstart.html?a=commitdiff_plain;h=6a38a3c54e0846dea625f5af0a4d365f9368acf6;p=tahoe-lafs%2Ftahoe-lafs.git

Rename README.txt to README.rst, and add Travis-CI and Coveralls badges to it.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
---

diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..6ab4e285
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,38 @@
+==========
+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.rst`_ in the docs directory.
+
+LICENCE
+=======
+
+Copyright 2006-2014 The Tahoe-LAFS Software Foundation
+
+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.rst`_ 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.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/quickstart.rst
+.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
+.. _COPYING.TGPPL.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
+.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
+
+----
+
+.. image:: https://travis-ci.org/tahoe-lafs/tahoe-lafs.png?branch=master
+  :target: https://travis-ci.org/tahoe-lafs/tahoe-lafs
+
+.. image:: https://coveralls.io/repos/tahoe-lafs/tahoe-lafs/badge.png?branch=master
+  :target: https://coveralls.io/r/tahoe-lafs/tahoe-lafs?branch=master
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 392e896e..00000000
--- a/README.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-==========
-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.rst`_ in the docs directory.
-
-LICENCE
-=======
-
-Copyright 2006-2014 The Tahoe-LAFS Software Foundation
-
-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.rst`_ 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.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/quickstart.rst
-.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
-.. _COPYING.TGPPL.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
-.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
diff --git a/docs/about.rst b/docs/about.rst
index 9c447ba9..6df61229 100644
--- a/docs/about.rst
+++ b/docs/about.rst
@@ -112,6 +112,6 @@ To use Tahoe-LAFS, please see quickstart.rst_.
 License
 =======
 
-Tahoe-LAFS is an open-source project; please see README.txt_ for details.
+Tahoe-LAFS is an open-source project; please see README.rst_ for details.
 
-.. _README.txt: ../README.txt
+.. _README.rst: ../README.rst
diff --git a/setup.py b/setup.py
index 469f7c87..7ae67612 100644
--- a/setup.py
+++ b/setup.py
@@ -434,11 +434,11 @@ if version:
 
 setup(name=APPNAME,
       description='secure, decentralized, fault-tolerant filesystem',
-      long_description=open('README.txt', 'rU').read(),
+      long_description=open('README.rst', 'rU').read(),
       author='the Tahoe-LAFS project',
       author_email='tahoe-dev@tahoe-lafs.org',
       url='https://tahoe-lafs.org/',
-      license='GNU GPL', # see README.txt -- there is an alternative licence
+      license='GNU GPL', # see README.rst -- there is an alternative licence
       cmdclass={"trial": Trial,
                 "make_executable": MakeExecutable,
                 "update_version": UpdateVersion,