Guide on how to setup a python project using poetry.
The README file introduces the project.
It contains all informations required to understand the project, the code and its usage.
The usual sections are “Installation”, “Usage”, “License” and “Contributing”.
It is usually written using markdown (.md files), here is a reference page.
A good tyemplate for a basic README file can be found here.
By default, poetry creates a reStructuredText file (.rst) that is empty, but that can be changed with a single command line (from the project directory)
rm README.rst && touch README.md