github.com/vlifesystems/rulehunter@v0.0.0-20180501090014-673078aa4a83/README.md (about)

     1  Rulehunter
     2  ==========
     3  
     4  [![Build Status](https://travis-ci.org/vlifesystems/rulehunter.svg?branch=master)](https://travis-ci.org/vlifesystems/rulehunter)
     5  [![Build status](https://ci.appveyor.com/api/projects/status/8tds5r4dk6163es0?svg=true)](https://ci.appveyor.com/project/lawrencewoodman/rulehunter)
     6  [![Coverage Status](https://coveralls.io/repos/vlifesystems/rulehunter/badge.svg?branch=master)](https://coveralls.io/r/vlifesystems/rulehunter?branch=master)
     7  [![Go Report Card](https://goreportcard.com/badge/github.com/vlifesystems/rulehunter)](https://goreportcard.com/report/github.com/vlifesystems/rulehunter)
     8  
     9  Rulehunter allows you to describe your goals and will then find simple rules to use on a supplied dataset to meet those goals.
    10  
    11  Getting Started
    12  ---------------
    13  * Follow the Rulehunter [installation](http://rulehunter.com/docs/installation/) instructions.  There are prebuilt binaries for a number of platforms.
    14  * Look at the [examples](http://rulehunter.com/docs/examples/) to get a feel for how Rulehunter can be used.
    15  * Read about its [configuration](http://rulehunter.com/docs/configuration/) and [usage](http://rulehunter.com/docs/usage/)
    16  * Start creating [experiments](http://rulehunter.com/docs/experiments/)
    17  * See the [Rulehunter](http://rulehunter.com) website for more information
    18  
    19  Testing
    20  -------
    21  To make testing simpler under Linux, where root is needed, you can use the following (replace _systemd_ with _upstart_ if using the latter init system):
    22  
    23  ```Shell
    24  sudo ./linux-test-su.sh $GOPATH `which go` systemd
    25  ```
    26  
    27  Contributing
    28  ------------
    29  We would love contributions to improve this project.  You can help by reporting bugs, improving the documentation, submitting feature requests, fixing bugs, etc.
    30  
    31  Please see the [Contributing Guide](https://github.com/vlifesystems/rulehunter/blob/master/CONTRIBUTING.md) for more details.
    32  
    33  Reporting Issues
    34  ----------------
    35  We want your help to find bugs as quickly as possible and would welcome your help by reporting any found.  Please see the [Contributing Guide](https://github.com/vlifesystems/rulehunter/blob/master/CONTRIBUTING.md) for more details of how to report them.
    36  
    37  Licence
    38  -------
    39  Copyright (C) 2016-2018 [vLife Systems Ltd](http://vlifesystems.com)
    40  
    41  Rulehunter is licensed under an MIT licence.  Please see [LICENSE.md](https://github.com/vlifesystems/rulehunter/blob/master/LICENSE.md) for details.
    42  
    43  Rulehunter also includes various libraries.  For more details about their licences please see the [licence](https://github.com/vlifesystems/rulehunter/blob/master/CONTRIBUTING.md#licence) section of the [Contributing Guide](https://github.com/vlifesystems/rulehunter/blob/master/CONTRIBUTING.md).