Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Mauri Mustonen committed Mar 12, 2022
1 parent 0835251 commit 7e0c176
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ contribute, check [Development](#development) how to get started.
* [Knowing Function Name](#knowing-function-name)
* [Disassemble Function](#disassemble-function)
* [Draw CFG](#draw-cfg)
* [Examples](#examples)
* [Examples](#examples)
* [Development](#development)
* [Python Environment](#python-environment)
* [Testing](#testing)
Expand Down Expand Up @@ -184,7 +184,7 @@ To view CFG instead of saving provide `-v` flag. And to skip function calls from
splitting the code to further blocks provide `-c` flag. To show the help use
`-h`.

## Examples
### Examples

Repository includes examples which can be used to test the standalone
functionality.
Expand Down Expand Up @@ -283,6 +283,14 @@ can execute module directly. For example to print help
python -m src.asm2cfg -h
```

Standalone method can be used to try out the examples under `examples` folder as
well. For example following command should generate `main.pdf` file to current
working directory.

```
python -m src.asm2cfg -c examples/huge.asm
```

### GDB Integration

Before testing GDB functionality, make sure asm2cfg is not installed with pip!
Expand Down

0 comments on commit 7e0c176

Please sign in to comment.