Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sransara committed Sep 12, 2023
1 parent 3fc02bb commit 5b9cd2c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
20 changes: 14 additions & 6 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ npm run build-external-deps

3. We are ready to roll

```
# Build the extension
npx vsce package
# Run tests
npm run test
```

## How it works

We are using VSCode [Custom Editor](https://code.visualstudio.com/api/extension-guides/custom-editors)
Expand Down Expand Up @@ -56,22 +64,22 @@ We use a simple RPC mechanism to communicate between VSCode and Speedscope.
```
Speedscope -> VSCode
{
clientEvent: 'ready'
clientEvent: 'ready'
}
VSCode -> Speedscope
{
serverCommand: 'openFile',
filename: 'simple.prof',
docbytes: Uint8Array(...)
serverCommand: 'openFile',
filename: 'simple.prof',
docbytes: Uint8Array(...)
}
Speedscope -> VSCode
{
clientEvent: 'opennedFile',
clientEvent: 'opennedFile',
}
or
{
clientEvent: 'error',
clientEvent: 'error',
}
```
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ This extension extends [speedscope](https://github.com/jlfwong/speedscope) to be
- Only files can be opened at the moment.
Allow directories as inputs to support opening [Instruments traces](https://help.apple.com/instruments/mac/10.0/).

## Build from source

```
# Build deps
npm install
npm run build-external-deps
# Build extension
npx vsce package
```

## Development

See [DEVELOPMENT.md](DEVELOPMENT.md) for development and implementation details.

0 comments on commit 5b9cd2c

Please sign in to comment.