Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add README with project overview and run instructions #199

Open
Farhad-Shabani opened this issue Jan 14, 2025 · 2 comments
Open

Add README with project overview and run instructions #199

Farhad-Shabani opened this issue Jan 14, 2025 · 2 comments
Assignees
@seanchen1991
Labels
documentation Improvements or additions to documentation
Milestone
MVP Demo #2

Comments

@Farhad-Shabani
Copy link
Member

Add a README that includes:

  • An overview of the project, briefly explaining what it does and how different parts come together.
  • Instructions on how to run the project, including any prerequisites or setup steps.
@Farhad-Shabani Farhad-Shabani added the documentation Improvements or additions to documentation label Jan 14, 2025
@rnbguy
Copy link
Member

rnbguy commented Jan 14, 2025

I second this. I always face difficulty with running the Cairo tests.

@soareschen
Copy link
Collaborator

Perhaps this would be a good onboarding for @seanchen1991

@Farhad-Shabani Farhad-Shabani added this to the MVP Demo #2 milestone Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@seanchen1991 seanchen1991

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
MVP Demo #2
Development

No branches or pull requests
4 participants
@soareschen @rnbguy @seanchen1991 @Farhad-Shabani