Skip to content

Commit

Permalink
Clean directory structure
Browse files Browse the repository at this point in the history
  • Loading branch information
RiffLord committed Jan 11, 2021
1 parent 7e31560 commit 12caf44
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ms
<i>ms</i> is a simple command line program which calculates musical note duration in milliseconds.
The program is intended to work like a typical command, with the user specifying a mandatory BPM value (as an integer or double)
and two optional commands, one for a note value (whole note through two hundred fifty-sixth note) and one to
and two optional commands: one for a note value (whole note through two hundred fifty-sixth note) and one to
specify that the note should be dotted. The syntax follows standard Linux commands with short and long options.
Type <b>./ms --help</b> or <b>./ms -?</b> to view the full list of options. If only the BPM value is provided the
program will calculate the duration of a standard quarter note.
Expand All @@ -11,15 +11,22 @@ The purpose of this program is to provide a quick and easy reference to the dura
note values, for example to set parameters of time-based effects such as reverb and delay so that
the tails and echoes stay in sync with the tempo of one's composition (the greater your use of these effects the more
this helps keep a clear mix). Although many time-based effects (especially VST plugins) have options
to sync to a track's tempo, sometimes you might want to fine tune to a specific amount.
to sync to a track's tempo, sometimes you might want to fine tune to a specific amount for finer control.

## Implementation
The program calculates the duration of a note length with a function that accepts a BPM value and a <i>measure subdivision</i>
as parameters. It then returns the result of the following calculation as a double value, rounded to 2 decimal points:

(60000 / BPM) / subdivision
<ul>
<li>(60000 / BPM) / subdivision</li>
</ul>

If no subdivision parameter is provided, it calculates a quarter note (or one beat) by default: (60000 / BPM).
If no subdivision parameter is provided, it calculates a quarter note (or one beat) by default:
<br>
<ul>
<li>(60000 / BPM)<li>
</ul>
<br>
For shorter notes the subdivision parameter assumes values that are multiples of 2. For half and whole notes,
subdivision assumes the value 0.5 and 0.25 respectively.

Expand Down
File renamed without changes.

0 comments on commit 12caf44

Please sign in to comment.