Skip to content

Added usage documentation #29

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

Open
Abhishek-gitty wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added usage documentation #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/usage/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Usage Guide

## Running the Project

Run the following commands:

```bash
python -m chuck generate-baselines
Copy link
Copy Markdown
Member

@Aaryan-Dadu Aaryan-Dadu Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add demo screenshots of your changes too

python -m chuck regress
python -m chuck bench
Copy link
Copy Markdown
Member

@Aaryan-Dadu Aaryan-Dadu Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the doc is just too short for a user to understand anything

Loading