phpmyadmin/README.rst
Allan Nordhøy 97277a958a
README reworked
Co-Authored-by: William Desportes <williamdes@wdes.fr>
Co-Authored-by: Saksham Gupta <shucon01@gmail.com>

[ci selenium skip]

Signed-off-by: William Desportes <williamdes@wdes.fr>
2021-02-09 12:08:10 +01:00

65 lines
2.6 KiB
ReStructuredText

phpMyAdmin
==========
A web interface for MySQL and MariaDB.
https://www.phpmyadmin.net/
Code status
-----------
.. image:: https://github.com/phpmyadmin/phpmyadmin/workflows/Run%20tests/badge.svg?branch=QA_5_1
:alt: Testsuite
:target: https://github.com/phpmyadmin/phpmyadmin/actions
.. image:: https://github.com/phpmyadmin/phpmyadmin/workflows/Run%20selenium%20tests/badge.svg?branch=QA_5_1
:alt: Selenium tests
:target: https://github.com/phpmyadmin/phpmyadmin/actions
.. image:: https://readthedocs.org/projects/phpmyadmin/badge/?version=qa_5_1
:target: https://docs.phpmyadmin.net/en/qa_5_1/
:alt: Documentation build status
.. image:: https://hosted.weblate.org/widgets/phpmyadmin/-/5-1/svg-badge.svg
:alt: Translation status
:target: https://hosted.weblate.org/engage/phpmyadmin/?utm_source=widget
.. image:: https://codecov.io/gh/phpmyadmin/phpmyadmin/branch/QA_5_1/graph/badge.svg
:alt: Coverage percentage
:target: https://codecov.io/gh/phpmyadmin/phpmyadmin
.. image:: https://scrutinizer-ci.com/g/phpmyadmin/phpmyadmin/badges/quality-score.png
:alt: Code quality score
:target: https://scrutinizer-ci.com/g/phpmyadmin/phpmyadmin/
.. image:: https://bestpractices.coreinfrastructure.org/projects/213/badge
:alt: CII Best Practices
:target: https://bestpractices.coreinfrastructure.org/projects/213
Download
--------
You can get the newest release at https://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 5.0.1 was tagged as ``RELEASE_5_0_1``.
Note that phpMyAdmin uses `Composer <https://getcomposer.org/>`_ to manage library dependencies, when using Git
development versions, you must manually run Composer.
Please see `the documentation <https://docs.phpmyadmin.net/en/latest/setup.html#installing-from-git>`_ for details.
More Information
----------------
Please see https://docs.phpmyadmin.net/, or browse the documentation in the doc folder.
For `support <https://www.phpmyadmin.net/support/>`_ or `security issues <https://www.phpmyadmin.net/security/>`_ you can visit https://www.phpmyadmin.net/
Translations are welcome, you can `translate phpMyAdmin to your language <https://hosted.weblate.org/projects/phpmyadmin/>`_.
If you would like to contribute to the phpMyAdmin's codebase, you can read the `code contribution file <CONTRIBUTING.md>`_ or browse our website's `contributing page <https://www.phpmyadmin.net/contribute/>`_.