jclif/serinette

# [serinette](http://jclif.github.io/serinette/)

Generates music from the command line.

[![Gem Version](https://badge.fury.io/rb/serinette.svg)](http://badge.fury.io/rb/serinette)
[![Code Climate](https://codeclimate.com/github/jclif/serinette/badges/gpa.svg)](https://codeclimate.com/github/jclif/serinette)
[![Build Status](https://travis-ci.org/jclif/serinette.svg?branch=master)](https://travis-ci.org/jclif/serinette)
[![Test Coverage](https://codeclimate.com/github/jclif/serinette/badges/coverage.svg)](https://codeclimate.com/github/jclif/serinette)
[![Dependency Status](https://gemnasium.com/jclif/serinette.svg)](https://gemnasium.com/jclif/serinette)
[![Documentation](https://inch-ci.org/github/jclif/serinette.svg?branch=master)](https://inch-ci.org/github/jclif/serinette)
[![Stories in Ready](https://badge.waffle.io/jclif/serinette.png?label=ready&title=Ready)](https://waffle.io/jclif/serinette)

## Installation

```
gem install serinette
```

## Basic Usage

We're not quite there yet, but it'll work something like this:

```
serinette orchestrate
```

Alternatively you can pass serinette a list of amazing flags and arguments and stuff (you can't yet)

```
serinette orchestrate --wow such --options
```

For more details check the available command-line options (none of these work):

```
serinette -h
```

Command flag              | Description
--------------------------|------------------------------------------------------------
`-v/--version`            | Displays the current version and exits.
`-V/--verbose-version`    | Displays the current version plus the version of Parser and Ruby.
`-d/--debug`              | Displays some extra debug output.
`-f/--format`             | Choose a formatter.

##Configuration

The behavior of Serinette can be controlled via the serinette.yml

```
Cool: A value or something

Style:
  Enabled: OhYes
```

## Team

Here's a list of Serinette's core developers:

* [Jared Clifton](https://github.com/jclif)
* [Austin Gatlin](https://github.com/aegnog)

## Logo

We don't have one.

If we did, it would be licensed under a
[Creative Commons Attribution-NonCommercial 4.0 International License](http://creativecommons.org/licenses/by-nc/4.0/deed.en_GB).

## Contributors

Here's a [list](https://github.com/jclif/serinette/contributors) of
all the people who have contributed to the development of Serinette.

If you'd like to contribute to Serintte, please take the time to go
through our short
[contribution guidelines](CONTRIBUTING.md).

You can also support my work on Serinette and
[all my other projects](https://github.com/jclif) via
[gratipay](https://www.gratipay.com/jclif), but why would you ever want to. [![Support via Gratipay](http://img.shields.io/gratipay/jclif.svg)](https://gratipay.com/jclif/)

If you'd like to chat about Serinette, check out chatroom.
[![Chatroom](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jclif/serinette?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Mailing List

If you're interested in everything regarding Serinette development,
we will soon be setting up a [google group](https://groups.google.com/), so check back in a bit.

## Freenode

Coming soon.

## Changelog

Serinette's changelog is available [here](CHANGELOG.md).

## Copyright

Copyright (c) 2015 Jared Clifton. See [LICENSE.txt](LICENSE.txt) for
further details.