stronk/Guitar-Sheet-Parser
1
0
Fork 0
mirror of https://github.com/stronk-dev/Guitar-Sheet-Parser.git synced 2025-07-05 00:25:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Marco van Dijk 2021-07-15 11:43:23 +02:00 committed by GitHub
parent ff1f14bef2
commit 0b6b25f3ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,2 +1,23 @@
# chordTabsToPrintables
Currently converts .txt files to separate .png files. Used to create printable images of tablature source files
This program converts source (guitar) tablature to printable formats
First it separates the input into metadata and [sections]
Then it tries to separate section data into lyric lines and non-lyric lines
Lastly it exports it to the chosen format
Currently it supports exporting to .txt and .png
Converting to .txt is useful to clean up the source file or as an input for other programs. It can also add metadata which makes parsing these files much easier
Converting to .png will try to minimise the amount of pages required (to prevent page flips and with limits on how much whitespace we allow). Then it will increase the font size to fill these pages as much as possible.
When the program is started for the first time it will create a ``config.ini`` file which can edited to change the behaviour of the program. For example, you might want to force the program to limit the amount of pages, regardless of whitespace.
By default it will try to parse all supported filetypes found in the current (sub)directory and convert them to A4 sized PNG files
Detailed config info: TBD