Skip to content

Commit

Permalink
Switch usage and installation section positions
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberrumor committed May 5, 2024
1 parent 4a8f178 commit b8c715d
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,30 @@ Features:
to quarter note intervals or smaller depending on desired
precision.


# Usage

```
usage: midilint [-h] [--velocity VELOCITY] [--snap SNAP] [--transpose TRANSPOSE] [--align] [--precision PRECISION] [--identify] SOURCE [DEST]
The midi linter.
positional arguments:
SOURCE the midi file to lint
DEST the name of the output file
options:
-h, --help show this help message and exit
--velocity VELOCITY the velocity to set all notes to
--snap SNAP the key to snap notes to. E.g. c_major or e_phrygian.
--transpose TRANSPOSE
the key to transpose to. E.g. c_major or e_phrygian.
--align align the start and end of notes to intervals
--precision PRECISION
determines the size of the interval to align to. 1 is quarter note, 2 is eighth, 4 is sixteenth, etc
--identify read information about a file
```

# Installation

Install Python 3.10 or newer for your operating system. Mac users can install brew, then install
Expand All @@ -38,26 +62,3 @@ pip3 install --user --break-system-packages .
# The method by which you achieve this depends on your operating system.
```

# Usage

```
usage: midilint [-h] [--velocity VELOCITY] [--snap SNAP] [--transpose TRANSPOSE] [--align] [--precision PRECISION] [--identify] SOURCE [DEST]
The midi linter.
positional arguments:
SOURCE the midi file to lint
DEST the name of the output file
options:
-h, --help show this help message and exit
--velocity VELOCITY the velocity to set all notes to
--snap SNAP the key to snap notes to. E.g. c_major or e_phrygian.
--transpose TRANSPOSE
the key to transpose to. E.g. c_major or e_phrygian.
--align align the start and end of notes to intervals
--precision PRECISION
determines the size of the interval to align to. 1 is quarter note, 2 is eighth, 4 is sixteenth, etc
--identify read information about a file
```

0 comments on commit b8c715d

Please sign in to comment.