[![Crates.io](https://img.shields.io/crates/v/tixonome)](https://crates.io/crates/tixonome)
# Tixonome

A simple CLI metronome in Rust.
By default, BPM is set to 72,  4/4 beats per bar (with accent).

## Installation

> Please make sure that `.cargo/bin/` is in your `PATH`.

### From crates.io

`cargo install tixonome`

### Directly from Github with git

`cargo install --git https://github.com/momozor/tixonome`

### Locally

`cargo install --path .`

## Usage

You can just run `tixonome` without extra arguments.
You can set the beats per minute and beats per bar through `-a` and `-b`.

Example:
```sh

tixonome -a 3 -b 120 # bpb at 3, and bpm 120

```

Maximum BPM: 180
Minimum BPM: 40

Maximum BPB: 4
Minimum BPB: 2

For more details, please run `tixonome --help`.


## Contributing

[Bug reports](https://github.com/momozor/tixonome/issues) and [pull requests](https://github.com/momozor/tixonome/issues) are welcome.


## License

This software is released under the BSD-3-Clause license. Please see
LICENSE file for more details.