Skip to content

Commit

Permalink
Improved the README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmr232 committed Dec 24, 2015
1 parent 1870404 commit d40a4f4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Expand Up @@ -9,10 +9,27 @@

## Installation

Clone the IDABuddy repository, then add `idabuddy\idabuddy_plugin.py`
to your `plugins.list` (`%AppData%\HexRays\plugins.list` or `C:\Program Files (x86)\IDA 6.9\cfg\plugins.list`).
1. Clone the IDABuddy repository
1. Add `idabuddy\idabuddy_plugin.py` to your `plugins.list` (`%AppData%\HexRays\plugins.list` or `C:\Program Files (x86)\IDA 6.9\cfg\plugins.list`).
1. Launch IDA

And you're good to go!

## Configuration

![](idabuddy/superida.png)
### What can I say?

IDABuddy's messages are stored in `sayings.yml`.

Basic sayings are lists of strings, spoken out one after the other.

Address sayings are single strings, with `{}` in them to denote the location
to put the address to jump to.

### How do I look?

Visual settings are stored in `config.yml`.

You can change the `stylesheet` to change the looks of the talk bubble,
or change the `image` to use a different buddy image.

![](help.png)
Binary file added help.png
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 d40a4f4

Please sign in to comment.