Skip to content

Commit

Permalink
doc: mention hook options in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nullpo-head committed Sep 8, 2022
1 parent c7ab359 commit f3f05de
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,32 @@ In addition, Dbgee frees you from the hassle of writing `launch.json` for VSCode

## Demos

The concept of Dbgee should be new and unfamiliar to you, so here are some demos to get you started.
Since the concept of Dbgee may be new to you, so here are some demos.

### Debug your program with zero configuration in Visual Studio Code

```shell
dbgee run -- ./cmd
```

<img alt="demo image" src="vscode-ext/images/DbgeeRunInVsCode.gif" width="850px">

### Find and attach to a process compiled from source files in the current directory, from all descendant processes of the given command

**Linux only**

```shell
dbgee run --hook-source-dir . -- ./any_run_script
```

<img alt="demo image" src="vscode-ext/images/DbgeeHookInVsCode.gif" width="850px">

### Configure your program to launch a debugger when it runs

```shell
dbgee set command
```

<img alt="demo image" src="vscode-ext/images/DbgeeSetInVsCode.gif" width="850px">

### Start a debug session with custom settings
Expand Down
4 changes: 4 additions & 0 deletions vscode-ext/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ or when your program is launched by some script.

<img alt="demo image" src="vscode-ext/images/DbgeeRunInVsCode.gif" width="850px">

### (Linux only) Find and attach to a process compiled from source files in the current directory, from all descendant processes of the given command

<img alt="demo image" src="vscode-ext/images/DbgeeHookInVsCode.gif" width="850px">

### Configure your program to wait for a debug session, no matter by what means it is started

<img alt="demo image" src="vscode-ext/images/DbgeeSetInVsCode.gif" width="850px">
Expand Down
Binary file added vscode-ext/images/DbgeeHookInVsCode.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f3f05de

Please sign in to comment.