Skip to content

Commit

Permalink
Fix TypeScript and add cli test
Browse files Browse the repository at this point in the history
  • Loading branch information
infojunkie committed Oct 21, 2024
1 parent 76b574e commit ee68096
Show file tree
Hide file tree
Showing 11 changed files with 10,120 additions and 74 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ iReal Pro to MusicXML converter.

# Demo

[Check out the demo!](https://blog.karimratib.me/demos/musicxml/) You can upload one of the [iReal Pro main playlists](https://www.irealpro.com/main-playlists/) as a test.
[Check out the demo!](https://blog.karimratib.me/demos/chirp/) You can upload one of the [iReal Pro main playlists](https://www.irealpro.com/main-playlists/) as a test.

# Usage

Expand Down Expand Up @@ -35,18 +35,22 @@ const playlistAsync = await iRealMusicXml.convert(ireal)

const playlistManual = new iRealMusicXml.Playlist(ireal)
// => Same as above minus `musicXml` attribute
const musicXml = iRealMusicXml.MusicXML.convert(playlistManual.songs[0])

const musicXml = iRealMusicXml.Converter.convert(playlistManual.songs[0])
// => MusicXML output
```

```bash
$ ireal-musicxml test/data/jazz.txt --songs=Blues
```

# Development

`xmllint` is required to run tests and the demo cli tool (but NOT for the library). Tests are used to ensure that the generated MusicXML is valid.
`xmllint` is required to run tests and the cli tool (but NOT for the library). Tests are used to ensure that the generated MusicXML is valid.

```
npm install
npm run test
./demo/cli/ireal-musicxml.js test/data/jazz.txt --songs=Blues --validate
```

# Documentation
Expand Down
Loading

0 comments on commit ee68096

Please sign in to comment.