Skip to content

README is empty — add basic project overview + quickstart #16

Description

@priyan17singh

Title: Add a basic README for onboarding (project overview + quickstart)

Body:
Hi maintainers 👋

The repository README is currently minimal, so it’s hard for new contributors to understand what EXXA contains and how to start.

What I’m proposing

Add a small README.md that includes:

  • a 1–2 line project overview
  • a list of top-level approach folders
  • a minimal quickstart (clone → venv → open Jupyter)
  • a short note that datasets/dependencies vary by folder

Why this helps

This improves onboarding/discoverability without changing any code or assumptions about datasets.

If you’re okay with it, I can open a PR with the README update.
Thanks!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions