Skip to content

Add docs #153

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

Merged
THenry14 merged 1 commit into from
Mar 25, 2025
Merged

Add docs #153

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
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,15 @@ asdf install cairo-profiler latest # Replace 'latest' with a specific version nu
Please remember to set global/project version to use:

```shell
asdf global cairo-profiler 0.7.0
# or
asdf local cairo-profiler 0.7.0
# in asdf <0.16.0
asdf local cairo-profiler latest
# OR
asdf global cairo-profiler latest

# or in asdf >= 0.16.0
asdf set cairo-profiler latest
# OR
asdf set -u cairo-profiler latest
```

### script:
Expand Down Expand Up @@ -128,6 +134,11 @@ Showing top 2 nodes out of 14
15 range check builtin | 37.50% | 92.50% | 15 range check builtin | 37.50% | "CallContract"
```

Viewing the nodes with everything from crate "core" filtered out:
```shell
cairo-profiler view path/to/profile.pb.gz --hide "^core::*"
```

#### Using pprof

Alternatively to see results from the generated file you can also use `pprof`. To do so, you will need to install:
Expand Down
Loading