Skip to content
This repository has been archived by the owner on Apr 6, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raviraina authored May 20, 2021
1 parent a76f685 commit 3fc0046
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,24 @@ As long as you're in the python environment, you can execute `mei2volpiano` or t
| Flag | Use |
| ------------- |:-------------:|
| `-W` or `-N` | Used to specify the type of MEI to converted (Neume or CWN) |
| `-t txt` or `-t mei`| Used to specify whether the user is inputtng MEI files or a text file containing MEI paths |
| `txt`| Used to specify whether the user is inputtng MEI files or a text file containing MEI paths |
| `--export` | Signifies that the converted Volpiano string(s) should be outputted to '.txt' files |

### Standard Usage (Neume notation)

To output the MEI file's volpiano string to the terminal, run

`mei2vol -N -t mei filename1.mei`
`mei2vol -N mei filename1.mei`

Multiple files can be passed in at once

`mei2vol -N -t mei filename1.mei filename2.mei`
`mei2vol -N mei filename1.mei filename2.mei`

### Western

To convert MEI files written in Common Western Music Notation (CWMN), run

`mei2vol -W -t mei filename1.mei`
`mei2vol -W mei filename1.mei`

All of the CWMN files processed by this library (so far) come from [this collection](https://github.com/DDMAL/Andrew-Hughes-Chant/tree/master/file_structure_text_file_MEI_file). Thus, we followed the conventions of those files. Namely:

Expand All @@ -58,7 +58,7 @@ The resulting volpiano string will have multiple notes seperated by two hyphens.

To make it easier to pass in multiple MEI files, the `-t` flag can be specified as `txt`:

`mei2vol -t txt filename1.txt` or `mei2vol -t txt filename1.txt filename2.txt ...`
`mei2vol -W txt filename1.txt` or `mei2vol -N txt filename1.txt filename2.txt ...`

where the ".txt" file being passed in must hold the name/relative path of the required MEI files on distinct lines.

Expand All @@ -68,7 +68,7 @@ where the ".txt" file being passed in must hold the name/relative path of the re

The `--export` tag can be used on any valid input to the program. Simply tack it on to the end of your command like so

`mei2vol -N -t mei filename1.mei --export`
`mei2vol -N mei filename1.mei --export`

and the program will output each mei file's volpiano to a similarly named file as its input.

Expand Down

0 comments on commit 3fc0046

Please sign in to comment.