aboutsummaryrefslogtreecommitdiffstats
path: root/bruiser/README.md
diff options
context:
space:
mode:
authorbloodstalker <thabogre@gmail.com>2017-06-11 22:48:16 +0000
committerbloodstalker <thabogre@gmail.com>2017-06-11 22:48:16 +0000
commit832749a02067ae8055787c0bb66cab8b997c59ee (patch)
treef2aa2053ab84aacdd0f6f54ae769d2675be421a3 /bruiser/README.md
parentimplemented the show source-code command (diff)
downloadmutator-832749a02067ae8055787c0bb66cab8b997c59ee.tar.gz
mutator-832749a02067ae8055787c0bb66cab8b997c59ee.zip
updated
Diffstat (limited to 'bruiser/README.md')
-rw-r--r--bruiser/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/bruiser/README.md b/bruiser/README.md
index 062ea3a..dacb22c 100644
--- a/bruiser/README.md
+++ b/bruiser/README.md
@@ -26,3 +26,17 @@ bruiser looks at your code, learns your code and then decides how to mutate your
### How?
I'm going to wrire about it as soon as I get my thoughts organized. In the meantime you can look at the source code for some hints.<br/>
+
+### Example
+First you should clone the mutator repo and run `git submodule init` and `git submodule update` to get the cool third-party repos that enable mutator to run.<br/>
+To build bruiser you can either run the makefile in bruiser's directory, then run `make` or just run the makefile at mutator's root directory and run `make bruiser`.<br/>
+After building bruiser, you can run it like any other mutator tool. So for example if you want to run bruiser on its test file run:<br/>
+
+```bash
+
+./bruiser ../test/bruisertest/test.cpp
+
+```
+
+After that you can just run your commands.<br/>
+bruiser, like any other libtooling tool will need it's entire compile command or a compilation databse. If you don't have a compilation database, take a look at [Bear](https://github.com/rizsotto/Bear).<br/>