Add comprehensive README for Friction Flow project

[leonvanbokhorst]

Summary by Sourcery

Documentation:

• Add a comprehensive README file for the Friction Flow project, detailing the project overview, key features, technical stack, and instructions for getting started.

Fixes #27

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR introduces a new README.md file that provides comprehensive documentation for the Friction Flow project. The README includes detailed sections covering the project overview, technical stack, setup instructions, development guidelines, and project structure.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added comprehensive project overview and key features documentation	Introduced project description focusing on Python-based research for analyzing human behavior Listed key features including multi-agent systems, psychological modeling, and LLM integration Detailed the technical stack including Python, PyTorch, Ray, FastAPI, and other dependencies	README.md
Added setup and development instructions	Provided step-by-step installation and setup instructions Included commands for running tests and simulations Outlined project structure and component organization	README.md
Established development standards and guidelines	Defined coding standards including PEP 8 and type hints requirements Specified test coverage requirements and SOLID principles adherence Outlined contribution guidelines and commit message format	README.md
Added project infrastructure documentation	Documented CI/CD workflow using GitHub Actions Included licensing information (Apache License 2.0) Added acknowledgments section for research foundations	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @leonvanbokhorst - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a 'Prerequisites' section that clearly specifies minimum system requirements, Python version compatibility, and setup instructions for external dependencies like Redis and Ollama.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 4 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}