The LyChoRhyce program guide

The LyChoRhyce program reads LCR-formatted song text files and writes beatiful HTML files, ready to be printed or converted to PDF files.

Installation

LyChoRhyce is a Python 3 program and requires a separate installation of the Python environment. The minimum supported Python version is 3.7.

After installing the Python environment, open a terminal and run the command:

$ pip3 install lychorhyce

If you cannot or do not want to install the program for the whole system, add the --user option.

Afterwards, you will be able to update the program by adding the -U (uppercase) option to the same command.

Open a terminal and switch to the directory containing your LCR files. Run the command:

$ lychorhyce FileName.lcr

(Currently there are no command line options nor configuration parameters.)

The program will parse your LCR file and generate a new one named FileName.html. Open the latter in a web browser to check the result.

If FileName.html already exists, you will be asked if you want to overwrite it.

If your LCR file contains errors, the program will tell you on what lines they are, and will try to continue anyway.

(The HTML title tag in the head section is populated from the file name, with underscores turned into spaces.)

The HTML files generated by the program may be converted into PDF files from within the web browser.

Alternatively, the WeasyPrint program may also be used (tested with v.52.2).

Install WeasyPrint and run the command:

$ weasyprint FileName.html FileName.pdf

The roadmap is tentative: no guarantees, no timelines.

v.1.0.0 betas (2021-04): initial releases.