Skip to content

Commit aa05648

Browse files
dnicolodirgommers
authored andcommitted
DOC: use reST for the readme too
IMHO reST is rendered in a nicer way than Markdown on PyPI. It is nice to have all the documentation in the same format.
1 parent 3d6afa6 commit aa05648

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

README.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. SPDX-FileCopyrightText: 2021 The meson-python developers
2+
3+
.. SPDX-License-Identifier: MIT
4+
5+
meson-python
6+
============
7+
8+
``meson-python`` is a Python build backend built on top of the Meson__
9+
build system. It enables to use Meson for the configuration and build
10+
steps of Python packages. Meson is an open source build system meant
11+
to be both extremely fast, and, even more importantly, as user
12+
friendly as possible. ``meson-python`` is best suited for building
13+
Python packages containing extension modules implemented in languages
14+
such as C, C++, Cython, Fortran, Pythran, or Rust. Consult the
15+
documentation__ for more details.
16+
17+
Questions regarding the use of ``meson-python`` can be directed to the
18+
discussions__ space on GitHub. Bug reports and feature requests can be
19+
filed as GitHub issues__.
20+
21+
__ https://mesonbuild.com/
22+
__ https://meson-python.readthedocs.io/en/latest/
23+
__ https://github.com/mesonbuild/meson-python/discussions/
24+
__ https://github.com/mesonbuild/meson-python/issues/

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ requires = [
1515
[project]
1616
name = 'meson-python'
1717
description = 'Meson Python build backend (PEP 517)'
18-
readme = 'README.md'
18+
readme = 'README.rst'
1919
requires-python = '>= 3.7'
2020
license = { file = 'LICENSES/MIT.txt' }
2121
keywords = ['meson', 'build', 'backend', 'pep517', 'package']

0 commit comments

Comments
 (0)