Make README files of sub-components obsolete

Since v0.14 everything belonging in a README file should be written
as part of the documentation and thus under docs/. Remove all
unnecessary README files, adjust MANIFEST.in and setup.py files
accordingly and move README files that should be merged into the
documentation under docs/older/.

This will be followed by a commit that merges all necessary
information included in the remaining REAMDE files under docs/older/
in the corresponding guides and docs, so that everything is up-to-date.
parent a3af45d8
include distribute_setup.py
include README
astakos-client
==============
Python client for the Astakos, the Identity Management Service of
synnefo(http://www.synnefo.org)
Feedback
========
For any comments or suggestions for improvement, please contact
the synnefo development team <synnefo-devel@googlegroups.com>
......@@ -49,7 +49,6 @@ from version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'A set of tools to ease versioning and use of git flow.'
PACKAGES_ROOT = '.'
......@@ -163,7 +162,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
global-include */templates/* */static/*
global-exclude */.DS_Store
......
......@@ -49,7 +49,6 @@ from astakos.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Synnefo Identity Management component'
PACKAGES_ROOT = '.'
......@@ -184,7 +183,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
recursive-include synnefo_branding/static *
README
=======
synnefo_branding app
......@@ -47,7 +47,6 @@ from synnefo_branding.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Synnefo stats grapher'
PACKAGES_ROOT = '.'
......@@ -155,7 +154,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
README
=======
snf-common provides a base layer of all synnefo related software.
......@@ -45,7 +45,6 @@ from synnefo.versions.common import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Common infrastructure for all Synnefo components'
PACKAGES_ROOT = '.'
......@@ -71,7 +70,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
......@@ -3,5 +3,4 @@ recursive-include synnefo/admin/static *
recursive-include synnefo/ui/static *
recursive-include docs/ *.rst
include README
include distribute_setup.py
README
=======
This is the top-level documentation file for the
Synnefo cloud management software.
Consult:
* docs/src/develop.rst: for information on how to setup a development environment
* docs/src/install.rst: for information on how to install the application
* docs/src/deploy.rst: for information on how to deploy the application
* docs/src/ci.rst: for information on how to setup a Jenkins-based
continuous integration system
* docs/src/i18n.rst: for information on application internationalization
Synnefo may be distributed under the terms of the following license:
Copyright 2011 GRNET S.A. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and
documentation are those of the authors and should not be
interpreted as representing official policies, either expressed
or implied, of GRNET S.A.
......@@ -47,7 +47,6 @@ from synnefo.versions.app import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Synnefo Compute, Network and Image component'
PACKAGES_ROOT = '.'
......@@ -188,7 +187,6 @@ setup(
license = 'BSD',
url = 'http://www.synnefo.org/',
description = SHORT_DESCRIPTION,
long_description=README,
classifiers = CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
......@@ -48,7 +48,6 @@ from snf_django.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Common Synnefo library for Django'
PACKAGES_ROOT = '.'
......@@ -162,7 +161,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
recursive-include pithos *.json *.html *.json *.xml *.txt
recursive-include pithos/ui/static *
include README
include distribute_setup.py
......@@ -47,7 +47,6 @@ from pithos.api.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Synnefo File/Object Storage component'
PACKAGES_ROOT = '.'
......@@ -172,7 +171,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
recursive-include pithos *.json *.html *.json *.xml *.txt
recursive-include pithos/backends/lib/sqlalchemy/alembic *
include README
include distribute_setup.py
README
======
Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/).
Learn more about Pithos at: http://code.grnet.gr/projects/pithos
Consult COPYRIGHT for licensing information.
About Pithos backend
--------------------
The backend is the library that handles the actual data storage and metadata management for Pithos. It is required by the Pithos application and can be used by any python script in need of direct access to Pithos storage services.
......@@ -47,7 +47,6 @@ from pithos.backends.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Backend library for the File/Object Storage component'
PACKAGES_ROOT = '.'
......@@ -170,7 +169,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
README
=======
snf-stats-app
......@@ -45,7 +45,6 @@ from synnefo_stats.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Synnefo graphic statistics component'
PACKAGES_ROOT = '.'
......@@ -67,7 +66,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
include README
include distribute_setup.py
......@@ -47,7 +47,6 @@ from synnefo_tools.version import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = 'Integration testing tool for a running Synnefo deployment'
PACKAGES_ROOT = '.'
......@@ -71,7 +70,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
......@@ -4,5 +4,4 @@ recursive-include synnefo/ui/static *
recursive-include docs/ *.rst
recursive-include extras/ *
include README
include distribute_setup.py
......@@ -48,7 +48,6 @@ from synnefo.versions.webproject import __version__
# Package info
VERSION = __version__
README = open(os.path.join(HERE, 'README')).read()
SHORT_DESCRIPTION = "Synnefo common infrastructure for Django"
PACKAGES_ROOT = "."
......@@ -167,7 +166,6 @@ setup(
license='BSD',
url='http://www.synnefo.org/',
description=SHORT_DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
author='Synnefo development team',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment