Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.29 KB

README.md

File metadata and controls

70 lines (50 loc) · 2.29 KB
Raw

Visual Studio Code ChordPro Extension

This extension provides ChordPro files support for VS Code.

ChordPro (also known as Chord) is an ASCII text file format for transcribing songs with chords and lyrics.
Although this format is legible as it is, there are many popular programs for displaying, transposing and printing.
Files in this format often have extensions such as .crd, .chopro, .pro, .chordpro or .cho. [wiki]

Features

  • Full syntax highlighting
  • Full syntax snippets
  • Rendering preview window
  • Export to PDF songbook

Animation

Requirements

None in this version.

Extension Settings

None in this version.

Known Issues

None.

Release Notes

This is the first release of VS Code ChordPro extension.
With it comes syntax highlighting support for one of the best song lyrics and chords format.

Future releases will have, at some point in time, improvements in the highlighting (add coloring by groups), and what's listed on the check list, in the Features section.

To check the latest changes, read the CHANGELOG.md.

Contributing

All contributions are more than welcome! If you want to get started with a PR, please do the following:
(3rd, 4th and 5th steps are not required yet)

  1. Check out the VS Code Extension Docs, especially Running and Debugging Extensions.
  2. Fork this repo.
  3. Install dependencies with npm install. You'll also need to install dependencies in the client and server directories.
  4. Run npm run watch in a shell to get the Typescript compiler running.
  5. Run npm run watch:client to compile the client and npm run watch:server to compile the server. You'll need all three running to do development on the extension.
  6. Open the repo directory in VS Code.
  7. Make a code change and test it.
    You can use the Debug tab and the Launch Extension configuration to help.
  8. Update the CHANGELOG.md.
  9. Create a branch and submit a PR!

License

This extension is licensed under the MIT License.