Add ChangeLog entry for #17586
[phpmyadmin.git] / README.rst
blob660db29b5af86b60835d9d1f4d89ab65358f3c07
1 phpMyAdmin
2 ==========
4 A web interface for MySQL and MariaDB.
6 https://www.phpmyadmin.net/
8 Code status
9 -----------
11 .. image:: https://github.com/phpmyadmin/phpmyadmin/workflows/Run%20tests/badge.svg?branch=master
12     :alt: Testsuite
13     :target: https://github.com/phpmyadmin/phpmyadmin/actions
15 .. image:: https://github.com/phpmyadmin/phpmyadmin/workflows/Run%20selenium%20tests/badge.svg?branch=master
16     :alt: Selenium tests
17     :target: https://github.com/phpmyadmin/phpmyadmin/actions
19 .. image:: https://readthedocs.org/projects/phpmyadmin/badge/?version=latest
20     :target: https://docs.phpmyadmin.net/en/latest/
21     :alt: Documentation build status
23 .. image:: https://hosted.weblate.org/widgets/phpmyadmin/-/master/svg-badge.svg
24     :alt: Translation status
25     :target: https://hosted.weblate.org/engage/phpmyadmin/?utm_source=widget
27 .. image:: https://codecov.io/gh/phpmyadmin/phpmyadmin/branch/master/graph/badge.svg
28     :alt: Coverage percentage
29     :target: https://codecov.io/gh/phpmyadmin/phpmyadmin
31 .. image:: https://scrutinizer-ci.com/g/phpmyadmin/phpmyadmin/badges/quality-score.png
32     :alt: Code quality score
33     :target: https://scrutinizer-ci.com/g/phpmyadmin/phpmyadmin/
35 .. image:: https://bestpractices.coreinfrastructure.org/projects/213/badge
36     :alt: CII Best Practices
37     :target: https://bestpractices.coreinfrastructure.org/projects/213
39 .. image:: https://shepherd.dev/github/phpmyadmin/phpmyadmin/coverage.svg
40     :alt: Type coverage
41     :target: https://shepherd.dev/github/phpmyadmin/phpmyadmin
43 .. image:: https://badge.stryker-mutator.io/github.com/phpmyadmin/phpmyadmin/master
44     :alt: Infection MSI
45     :target: https://infection.github.io
48 Download
49 --------
51 You can get the newest release at https://www.phpmyadmin.net/.
53 If you prefer to follow the Git repository, the following branch and tag names may be of interest:
55 * ``STABLE`` is the current stable release.
56 * ``master`` is the development branch.
57 * Releases are tagged, for example version 5.0.1 was tagged as ``RELEASE_5_0_1``.
59 Note that phpMyAdmin uses `Composer <https://getcomposer.org/>`_ to manage library dependencies, when using Git
60 development versions, you must manually run Composer.
61 Please see `the documentation <https://docs.phpmyadmin.net/en/latest/setup.html#installing-from-git>`_ for details.
63 More Information
64 ----------------
66 Please see https://docs.phpmyadmin.net/, or browse the documentation in the doc folder.
68 For `support <https://www.phpmyadmin.net/support/>`_ or `security issues <https://www.phpmyadmin.net/security/>`_ you can visit https://www.phpmyadmin.net/
70 Translations are welcome, you can `translate phpMyAdmin to your language <https://hosted.weblate.org/projects/phpmyadmin/>`_.
72 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/>`_.