From 26ab0195c772c58e1d2263f2555e68da6e3b537f Mon Sep 17 00:00:00 2001 From: Gustav Eek Date: Tue, 20 Aug 2024 09:17:01 +0200 Subject: [PATCH] [doc] In README, provide introduction and installation instructions --- README | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/README b/README index f5c428a..44d9abe 100644 --- a/README +++ b/README @@ -8,6 +8,78 @@ Väth's *guitar* package with high level environments for song sectioning: chorus, verse and bridge, etc. The software bundle also contains tools for conversions between various chord note formats. +This is a LaTeX3 package (LaTeX3 is actually LaTeX continued on top +of LaTeX2e). See [Introduction to LaTeX3 +ideas](http://texdoc.net/pkg/expl3) for throughout details. + + +# Introduction + +Important inspiration is the ChordPro format as well as Ultimate +Guitar's sectioning in their text format and Wikipedia's "Song +structure", "Verse–chorus form". Pre-defined song sections: + + * Introduction, intro + * Verse, verse + * Bridge, bridge + * Pre-chorus prech + * Chorus or refrain, chorus + * Post-chorus postch + * Conclusion or outro, outro + * Elision, elison + * Instrumental solo, instr + * Ad lib, ad-lib + * Break, break + +The ideal process is text → ChordPro → LaTeX. We use the package +*guitar*, which syntax resembles ChordPro. + +The package develops sophisticated (colour) schemas for sections and +annotations. + +Refer to [the documentation](doc) for details. + + +# Installation and dependencies + +Running Make will install the LaTeX package *guitarsections* as +well as the Bash tools: + + make install + +LaTeX stuff will be installed in *~/texmf* and tools in +*~/.local/bin*. Similarly `make uninstall` will reverse the process. + + +## Dependencies + +Of course LaTeX itself i a dependency as well as the *guitar* LaTeX +package. In Debian it is found as *texlive-music*. The tools requires +Chord Pro's *a2crd*. Install the latter according to instructions. + +# Motivation and Similar projects + +Regarding other projects in the area there is plenty to say. The work +put in by others is thorough an the outcome generally great. + +The motivation behind this package is particular; The author needed an +LaTeX environment, easily enclosed in regular documents, that produces +themed verses and resembles the Chord Pro format. For that particular +purpose, this package should motivate it's shelf space. + +Reading the guide *latex4musicians* is profitable. It covers most +music related typesetting problems and suitable projects. + +Write to the author for a list of great LaTeX and general Chord Pro +projects. + + +# Contact + +Send the author an email and ask for a phone call. Even better, pay a +visit for a glass and supper. There is nothing better that discussing +song typesetting between peers. + # Copying *Guitar Sections* is a LaTeX song book compilation package adopted for -- 2.39.2