From b7da5df5eef6dd6be2a8888035f2dd0077e6ebaa Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 13 Jul 2014 22:23:59 -0700 Subject: [PATCH] Docs/changelog for #866 --- docs/changelog.rst | 1 + docs/plugins/bpm.rst | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 290d0531d..0dbfa0b88 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,6 +12,7 @@ New stuff IFF chunks. * A new :ref:`required` configuration option for the importer skips matches that are missing certain data. Thanks to oprietop. +* The new :doc:`/plugins/bpm` lets you manually measure the tempo of a playing song. Thanks to aroquen. Little improvements and fixes: diff --git a/docs/plugins/bpm.rst b/docs/plugins/bpm.rst index 6359f9501..47a37a8c1 100644 --- a/docs/plugins/bpm.rst +++ b/docs/plugins/bpm.rst @@ -1,18 +1,18 @@ BPM Plugin ========== -This ``bpm`` plugin allows to determine the bpm (beats per minute) of a song by recording the user's keystrokes. The rationale is that sometimes the bpm of a song cannot be obtained from the echonest database (via the ``echonest`` plugin) or it is simply plain wrong. Whenever you need to fix the bpm of a song manually, the ``bpm`` plugin comes to the rescue. +This ``bpm`` plugin lets you to get the tempo (beats per minute) of a song by tapping out the beat on your keyboard. Usage ------- +----- -First, enable the plugin ``bpm`` as described in :doc:`/plugins/index`. Then, suppose you want to set or modify the bpm of ````, where ```` is any valid query that matches the song of interest. Start playing it with your favorite media player, fire up a terminal and type:: +First, enable the plugin ``bpm`` as described in :doc:`/plugins/index`. Then, play a song you want to measure in your favorite media player and type:: beet bpm -You'll be prompted to press Enter three times to the rhythm. This typically allows to determine the bpm within 5% accuracy. +You'll be prompted to press Enter three times to the rhythm. This typically allows to determine the BPM within 5% accuracy. -The plugin works best if you wrap it in a script that gets the playing song, for instance with ``mpc`` you can do something like:: +The plugin works best if you wrap it in a script that gets the playing song. for instance, with ``mpc`` you can do something like:: beet bpm $(mpc |head -1|tr -d "-")