From 30d1b5845d293a6bb6052086c540eff34146dbdb Mon Sep 17 00:00:00 2001 From: Isaac Bennetch Date: Mon, 23 Jun 2014 18:20:08 -0400 Subject: [PATCH] * Consolidate README to eliminate some duplicate information * Editing README.rst to make it more friendly as our github home page * Move third party license info to copyright file Signed-off-by: Isaac Bennetch --- README | 85 ++++++++--------------------------------------- README.rst | 13 +++++--- doc/copyright.rst | 20 +++++++++++ 3 files changed, 42 insertions(+), 76 deletions(-) diff --git a/README b/README index 538b39af6d..7a05f035c4 100644 --- a/README +++ b/README @@ -7,22 +7,22 @@ A set of PHP-scripts to manage MySQL over the web. http://www.phpmyadmin.net/ +Summary +------- + +phpMyAdmin is intended to handle the administration of MySQL over the web. +For a summary of features, list of requirements, and installation instructions, +please see the documentation in the ./doc/ folder or at http://docs.phpmyadmin.net/ + Copyright --------- -Copyright (C) 1998-2000 - Tobias Ratschiller +Copyright © 1998 onwards -- the phpMyAdmin team -Copyright (C) 2001-2014 - Marc Delisle - Olivier Müller - Robin Johnson - Alexander M. Turek - Michal Čihař - Garvin Hicking - Michael Keck - Sebastian Mendel - [check documentation for more details] +Certain libraries are copyrighted by their respective authors; +see the full copyright list for details. + +For full copyright information, please see ./doc/copyright.rst License ------- @@ -46,66 +46,7 @@ Beginning on 2013-12-01, new contributions to this codebase are all licensed under terms compatible with GPLv2-or-later. phpMyAdmin is currently transitioning older code to GPLv2-or-later, but work is not yet complete. -Third party licenses --------------------- - -phpMyAdmin includes several third party libraries which come under their -respective licenses. - -jQuery's license, which is where we got the files under js/jquery/ is -(MIT|GPL), a copy of each license is available in this repository (GPL -is available as LICENSE, MIT as js/jquery/MIT-LICENSE.txt). - -TCPDF which is located under libraries/tcpdf is released under GPL -version 3 and the license is available as libraries/tcpdf/LICENSE.TXT. - -DejaVu fonts which are located under libraries/tcpdf/fonts/ and their -license is documented in -libraries/tcpdf/fonts/dejavu-fonts-ttf-2.33/LICENSE. - -PHP-gettext which is located under libraries/php-gettext/ is released -under GPL version 2 license which is available in the LICENSE file. - -Requirements ------------- - -* PHP 5.3 or later -* MySQL 5.0 or later -* a web-browser (doh!) - -Summary -------- - -phpMyAdmin is intended to handle the administration of MySQL over the web. -For a summary of features, please see the documentation in the doc folder. - -Download --------- - -You can get the newest version at http://www.phpmyadmin.net/. - -More Information ----------------- - -Please see the documentation in the doc folder. - -Support -------- - -See reference about support forums under http://www.phpmyadmin.net/ - - Enjoy! ------ -The phpMyAdmin Devel team - - -PS: - -Please, don't send us emails with question like "How do I compile PHP with -MySQL-support". We just don't have the time to be your free help desk. - -Please send your questions to the appropriate mailing lists / forums. Before -contacting us, please read the documentation (especially the FAQ part). - +The phpMyAdmin team diff --git a/README.rst b/README.rst index 33a9b5b60a..eae86eeccb 100644 --- a/README.rst +++ b/README.rst @@ -25,14 +25,19 @@ Code status Download -------- -You can get the newest version at http://www.phpmyadmin.net/. +You can get the newest release at http://www.phpmyadmin.net/. + +If you prefer to follow the git repository, the following branch and tag names may be of interest: + +* ``STABLE`` is the current stable release. +* ``master`` is the development branch. +* Releases are tagged, for example version 4.0.1 was tagged as ``RELEASE_4_0_1``. More Information ---------------- Please see the documentation in the doc folder or at http://docs.phpmyadmin.net/. -Support -------- +For support or to learn how to contribute code or by translating to your language, +visit http://www.phpmyadmin.net/ -See reference about support forums under http://www.phpmyadmin.net/ diff --git a/doc/copyright.rst b/doc/copyright.rst index 383efbb2bb..fc5fdac346 100644 --- a/doc/copyright.rst +++ b/doc/copyright.rst @@ -28,3 +28,23 @@ General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see `http://www.gnu.org/licenses/ `_. + +Third party licenses +++++++++++++++++++++ + +phpMyAdmin includes several third party libraries which come under their +respective licenses. + +jQuery's license, which is where we got the files under js/jquery/ is +(MIT|GPL), a copy of each license is available in this repository (GPL +is available as LICENSE, MIT as js/jquery/MIT-LICENSE.txt). + +TCPDF which is located under libraries/tcpdf is released under GPL +version 3 and the license is available as libraries/tcpdf/LICENSE.TXT. + +DejaVu fonts which are located under libraries/tcpdf/fonts/ and their +license is documented in +libraries/tcpdf/fonts/dejavu-fonts-ttf-2.33/LICENSE. + +PHP-gettext which is located under libraries/php-gettext/ is released +under GPL version 2 license which is available in the LICENSE file.