📖 Describe what you want

• Readme should have a short description of the project

• Readme should have a table of content see here

• Readme should have the following parts

  • What the project is
  • How normal people should interact with it
    • Where is the website: SentimentalBB
    • Where they can see the last availble results (reports/figures/)
    • How they can setup their environment (poetry install) such as to predict on tweets (poetry run ...)
  • How people can contribute (Setup.md and CONTRIBUTING.md)
    • Associated details to explain things if necessary (what's currently on the readme)
  • Contributors

✔️ Definition of done

All the listed element appears on the Readme.md when visiting https://github.com/42-AI/SentimentalBB