From b86f693e42936558a3b84010759266fe96cb29fa Mon Sep 17 00:00:00 2001 From: Ivan Holmes Date: Thu, 31 Oct 2019 17:00:51 +0000 Subject: [PATCH] updated README --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 92b5330..9bb3dc5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # 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. @@ -7,9 +6,14 @@ I wrote Chordsheet because no other software offered what I was looking for. I d Chordsheet works on a system of blocks, each with a certain length. Blocks may have an assigned chord, or additional information. These blocks can then be ordered and the output generated. -## Current status +## Get started +To run Chordsheet, go to the Releases tab and download the most recent version for your OS. Releases are currently provided for macOS and Windows. These binaries are created with PyInstaller and so can't be used for development. You do not need to install anything else to run Chordsheet this way. + +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. + ### Limitations - No support for multiple pages - Only guitar chords can be entered and shown @@ -20,4 +24,11 @@ Chordsheet is alpha-grade software. At present, the program will crash readily g ## Dependencies Chordsheet depends on pymupdf (to show the preview), reportlab (to generate the PDF), and PyQt5 (for the GUI). -Also, a font that supports musical symbols is required. A copy of FreeSans is bundled (in the fonts folder). \ No newline at end of file +Also, a font that supports musical symbols is required. A copy of FreeSans is bundled (in the fonts folder). +This command should sort you out: +```bash +pip3 install pymupdf reportlab pyqt5 +``` + +## License +Chordsheet is licensed under the AGPLv3, included in full in 'LICENSE'.