# warning!

this project has [moved](https://gitlab.com/nissaofthesea/tempo).
the last version of `tempo` using Rust is `0.5.4`.

# tempo

[![Crates.io](https://img.shields.io/crates/v/tempo_tapper)](https://crates.io/crates/tempo_tapper)
[![Crates.io](https://img.shields.io/crates/l/tempo_tapper)](https://crates.io/crates/tempo_tapper)

`tempo` is a terminal tempo tapper.

```
...

1/10 samples in buffer
106.3 bpm
 * <enter>

2/10 samples in buffer
110.4 bpm
 * c

0/10 samples in buffer
0.0 bpm
 ; █
```

## concept

`tempo` works by collecting bpms into a buffer as you tap.

```
[120.5, 124.3, 122.6, _, _, _, _, _, _, _]
 ^                                      ^
new bpms inserted here        old bpms removed here
```

the final bpm is the average of all samples in the buffer.

## usage

to use `tempo`, tap to the desired tempo, and it will display the average bpm.

for more fine tuning, you can also adjust the size of the buffer.
the bpm may be more accurate the more samples are averaged.

| command   | description                     |
|-----------|---------------------------------|
| h         | show help                       |
| \<enter\> | register a tap                  |
| c         | clear buffer                    |
| s         | adjust buffer size              |
| b         | bound or unbound buffer to size |
| p         | print buffer contents           |
| l         | print license info              |
| q         | quit                            |

## installation

since `tempo` is on crates.io under the name `tempo_tapper`, you can install it with cargo!

```console
$ cargo install tempo_tapper
```

### documentation

there *is* also documentation available as man pages.
building them requires [scdoc](https://git.sr.ht/~sircmpwn/scdoc) and probably [GNU Make](https://www.gnu.org/software/make), although the makefile is uncomplicated.

to install:

```console
$ make -C ./docs install
```

and to uninstall:

```console
$ make -C ./docs uninstall
```

## rustc

the msrv (minimum supported Rust version) is `1.61.0`.

## license

`tempo` is licensed under the MIT or Apache 2.0 licenses, at your choice.