ivan
/
chordsheet
1
0
Fork 0
Code Issues Pull Requests Releases 11 Wiki Activity
Browse Source

Update readme

master
Ivan Holmes 4 years ago
parent
eb55561f31
commit
aa4228f436
1 changed files with 12 additions and 2 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      README.md

14
README.md
View File

@ -3,12 +3,12 @@ Chordsheet is a piece of software that generates a chord sheet, with a simple GU
It can load and save chordsheets in its own XML-based format, and can save them in PDF format for printing. 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. 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).
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 and piano chords (with a view to supporting other instruments in future).
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. 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.
## Get started ## 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 run Chordsheet, go to the Releases tab and download the most recent version for your OS. Releases are currently provided for macOS, Linux 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! To develop Chordsheet, clone this repository and run gui.py using a recent Python 3 interpreter. Make sure you have the dependencies installed!
@ -36,5 +36,15 @@ This command should sort you out:
pip3 install pymupdf reportlab pyqt5 pip3 install pymupdf reportlab pyqt5
``` ```
## Building
To build the binary distribution using PyInstaller, simply run:
```bash
pyinstaller {mac|linux|win}.spec
```
The generated binary will be in the 'dist' subfolder.
### Version number on Windows
If you are building on Windows and alter the version number, make sure to run `generate_version_rc.py` to update the version.rc file. This file is included in the generated executable and contains the version information viewable in Windows Explorer properties.
## License ## License
Chordsheet is licensed under the AGPLv3, included in full in 'LICENSE'. Chordsheet is licensed under the AGPLv3, included in full in 'LICENSE'.
Write Preview
Loading…
Cancel
Save