Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
sransara committed Oct 13, 2023
1 parent f00a8d2 commit 69e4ccd
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Speedscope in VScode
# Speedscope in VSCode

VSCode extension for viewing speedscope flamegraphs.
VSCode extension for viewing [Speedscope](https://github.com/jlfwong/speedscope) flamegraphs.

[Speedscope](https://www.speedscope.app/) is:
## Why not just use the [Speedscope app](https://www.speedscope.app/)?

> A fast, interactive web-based viewer for performance profiles.
> An alternative viewer for FlameGraphs.
> Will happily display multi-megabyte profiles without crashing your browser.
>
> from https://github.com/jlfwong/speedscope
With this extension you can open Speedscope compatible files directly from VSCode and jump to the source code locations of the profiled functions.

## Installation

Expand All @@ -30,17 +26,17 @@ This extension extends [speedscope](https://github.com/jlfwong/speedscope) to be

### Support opening remote files

- Use "Open with..." from VSCode File Explorer like a local file
- Use "Open with..." from VSCode File Explorer just like a local file

### Open a Speedscope view with command: `speedscope-in-vscode.openSpeedscope`

### Directly open files

(if relative path assume it is relative to the file being viewed)
### From a Speedscope view jump to profiled source file locations

- Ctrl + click on a colored block to open the associated file
- Or click link to a file in the stack detail view

(if relative path assume it is relative to the file being viewed)

## TODO

- Only files can be opened at the moment.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"type": "git",
"url": "https://github.com/sransara/speedscope-in-vscode.git"
},
"version": "0.0.6",
"version": "0.0.7",
"license": "MIT",
"engines": {
"vscode": "^1.81.0"
Expand Down

0 comments on commit 69e4ccd

Please sign in to comment.