[TASK] remove `README.rst`

LaurenzBeck commented 2 months ago

✅ Task

There are two READMEs in the project. README.md seems to be the actively used one. I did a quick search, and README.rst apparently is only mentioned in tool.poetry.readme in pyproject.toml, which probably is the link to the README, that is used for the PyPi site of NiaAML. PyPi can handle markdown files, so I would recommend removing README.rst to have a single place to maintain.

📃 Checklist

[ ] remove README.rst
[ ] link to README.md in pyproject.toml
[ ] check if PyPi renders the README correctly

firefly-cpp commented 2 months ago

+1

sisco0 commented 1 month ago

[x] remove README.rst: File could be removed without inconvenience. References for the given file are only in the changelog files.
[x] link to README.md in pyproject.toml: Already performed in commit 1929e76f9932a51d968038eed2a13bd77db087d6 by @firefly-cpp .
[x] check if PyPi renders the README correctly: Evidence at https://test.pypi.org/project/NiaAML/

Creating Pull Request.

firefly-cpp / NiaAML

[TASK] remove `README.rst` #95

✅ Task

📃 Checklist