Browse Source

Update readme

master
Ivan Holmes 4 years ago
parent
commit
25779ddbbb
  1. 12
      README.md

12
README.md

@ -1,6 +1,7 @@
# Chordsheet
Chordsheet is a piece of software that generates a chord sheet, with a simple GUI.
It can load and save chordsheets in its own XML-based format, and can save them in PDF format for printing.
It's now possible to write a chordsheet in a custom macro language, and import this for further editing in the GUI. See the examples folder for details.
I wrote Chordsheet because no other software offered what I was looking for. I did not want to have to enter lyrics (most of the music I am charting is instrumental anyway), needed definite timing information, and wanted to be able to represent guitar chords (with a view to supporting other instruments in future).
@ -12,15 +13,20 @@ To run Chordsheet, go to the Releases tab and download the most recent version f
To develop Chordsheet, clone this repository and run gui.py using a recent Python 3 interpreter. Make sure you have the dependencies installed!
## Current status
Chordsheet is alpha-grade software. At present, the program will crash readily given user input it doesn't expect.
Chordsheet is beta-grade software. Most things should work, but I haven't tested it too extensively.
### Features
- Guitar and piano chords can be entered and rendered
- Multiple sections of the same piece are supported
- Supports reading Chordsheet macro files (custom macro language designed to make it easy to quickly generate chordsheets, see examples folder)
- High quality PDF output
### Limitations
- Only guitar chords can be entered and shown
- No support for lyrics or melody (use something else!)
- PDF preview is blurry on high DPI monitors
- Chord names and notes can spill out of their block if it's not big enough (partially remedied by allowing the user to change the beat width)
- Poor font handling (choice of either FreeSans or Helvetica Neue if installed)
- No support for printing
- No internal support for printing
## Dependencies
Chordsheet depends on pymupdf (to show the preview), reportlab (to generate the PDF), and PyQt5 (for the GUI).

Loading…
Cancel
Save