Skip to content

SongProOrg/songpro-crystal

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 

SongPro for Crystal

SongPro is a text format for transcribing songs.

This project is a Crystal Shard that converts the song into a Song data model which can then be converted into various output formats such as text or HTML.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      songpro:
        github: SongProOrg/songpro-crystal
  2. Run shards install

Usage

require "songpro"

song = SongPro.parse(text)

TODO: Write usage instructions here

Development

After checking out the repo, run crystal spec to run the tests.

Contributing

  1. Fork it (https://github.com/SongProOrg/songpro-crystal/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

A Crystal Shard to convert SongPro songs to a Song object used to generate various output formats.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published