kotovalexarian/free_mutant
1
0
Fork 0
Code Releases Activity

Merge pull request #771 from mbj/improve/readme

Browse source 
Improve Readme
This commit is contained in:
Markus Schirp 2018-11-20 14:23:23 +00:00 committed by GitHub
commit 90ad27bd04
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -12,14 +12,11 @@ Mutant is a mutation testing tool for Ruby.
The idea is that if code can be changed and your tests do not notice, then either that code isn't being covered The idea is that if code can be changed and your tests do not notice, then either that code isn't being covered
or it does not have a speced side effect. or it does not have a speced side effect.
Mutant supports ruby >= 2.1, while support for JRuby is planned. Mutant supports ruby >= 2.5, MRI only.
It should also work under any Ruby engine that supports POSIX-fork(2) semantics.
Mutant uses a pure Ruby [parser](https://github.com/whitequark/parser) and an [unparser](https://github.com/mbj/unparser) Mutant uses a pure Ruby [parser](https://github.com/whitequark/parser) and an [unparser](https://github.com/mbj/unparser)
to do its magic. to do its magic.
Mutant does not have really good "getting started" documentation currently so please refer to presentations and blog posts below.
Installation Installation
------------ ------------
@ -30,8 +27,6 @@ It'll pull the `mutant` gem (in the correct version), that contains the main eng
gem install mutant-rspec gem install mutant-rspec
``` ```
The minitest integration is still in the [works](https://github.com/mbj/mutant/pull/445).
Examples Examples
-------- --------
@ -254,6 +249,7 @@ Only Mutating Changed Code
-------------------------- --------------------------
Running mutant for the first time on an existing codebase can be a rather disheartening experience due to the large number of alive mutations found! Mutant has a setting that can help. Using the `--since` argument, mutant will only mutate code that has been modified. This allows you to introduce mutant into an existing code base without drowning in errors. Example usage that will mutate all code changed between master and the current branch: Running mutant for the first time on an existing codebase can be a rather disheartening experience due to the large number of alive mutations found! Mutant has a setting that can help. Using the `--since` argument, mutant will only mutate code that has been modified. This allows you to introduce mutant into an existing code base without drowning in errors. Example usage that will mutate all code changed between master and the current branch:
``` ```
bundle exec mutant --include lib --require virtus --since master --use rspec Virtus::Attribute#type bundle exec mutant --include lib --require virtus --since master --use rspec Virtus::Attribute#type
``` ```