Browse Source

Update the readme

Clarifications etc.
master
Ivan Holmes 4 years ago
parent
commit
d315f13868
  1. 6
      README.md

6
README.md

@ -10,10 +10,10 @@ Chordsheet works on a system of blocks, each with a certain length. Blocks may h
## 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, 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 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 Python 3.7 or newer. Make sure you have the dependencies installed!
## Current status ## Current status
Chordsheet is beta-grade software. Most things should work, but I haven't tested it too extensively.
Chordsheet is alpha-grade software. Most things should work, but I haven't tested it too extensively.
### Features ### Features
- Guitar and piano chords can be entered and rendered - Guitar and piano chords can be entered and rendered
@ -36,6 +36,8 @@ This command should sort you out:
pip3 install pymupdf reportlab pyqt5 pip3 install pymupdf reportlab pyqt5
``` ```
Note that if you have downloaded a binary from the Releases tab, these libraries are included already so you don't need to install them separately.
## Building (freezing) ## Building (freezing)
To build the binary distribution using PyInstaller, simply run: To build the binary distribution using PyInstaller, simply run:
```bash ```bash

Loading…
Cancel
Save