diff options
Diffstat (limited to '')
| -rw-r--r-- | bruiser/README.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/bruiser/README.md b/bruiser/README.md index 648e587..48fdafe 100644 --- a/bruiser/README.md +++ b/bruiser/README.md @@ -4,7 +4,7 @@ Bruiser is implemented as an interactive commandline interface. It features an embedded lua interpreter plus the history and auto-completion and suggestion features we have all come to expect from shell-like tools.<br/> Regarding the actual functionality, it will feature non-blind selective mutations. You can ask it to list information regrading the source codes it is run on. The eventuality of this idea is to help with maintaining code or in giving the viewer an overview of the code. The final feature is the name-sake. It looks at the code and decides how to break it. For more explanation please read on.<br/> -### How it Works? +### How does it work? To put it simply, bruiser is an interactive lua interpreter that uses linenoise for shell-like features(history, tab-completion, auto-suggestion). You get the full power of lua plus the bruiser functions whcih are implemented as lua scripts that call back to the cpp code to get things done.<br/> To put this into perspecttive, think you run `list vars` in bruiser. It gets you the list of vars but that's it. You can't save them to a file or do anything else with them. With the old way of doing things I had to add a command that did that and then you could do it but what if you wanted to do something else? what then? well you get the idea. That would also mean that bruiser's language would be made up gradually which would result in something ugly and warrant a lot of rewrites.<br/> With the new way of doing things, the user is only limited by their imagination and lua, not me, and there is no learning curve for learning a garbage language that I would have to come up with.<br/> @@ -47,4 +47,12 @@ For example you can run one of the example scripts that come with bruiser like t dofile("./lua-scripts/testfile1.lua") ``` -bruiser requires a compilation database to run. If you don't have a compilation database, take a look at [Bear](https://github.com/rizsotto/Bear).<br/> + +You can also run bruiser in non-cli mode:<br/> +```bash + +./bruiser ../test/bruisertest/test.cpp -lua="./lua-scripts/mutation-example.lua" + +``` + +bruiser requires a compilation database to run. If you don't have a compilation database, take a look at [Bear](https://github.com/rizsotto/Bear). If you're using `cmake`, just tell it to generate a compilation database.<br/> |