Skip to content

Commit f3acd84

Browse files
committed
update readme with an example
1 parent 0cd7dd6 commit f3acd84

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

Diff for: README.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,38 @@ A very opinionated command:
106106
\psalm[<gloria/no gloria>][<title>]{<psalm>}{<mode>}
107107
```
108108

109-
Other options will be added as needed/requested.
109+
For example, ```\psalm[ng]{15}{7c}``` will set psalm XV to 7c without a Gloria.
110+
This command in itself, though opinionated, can be used with other commands to
111+
great effect. Here is an example from my
112+
[chant](https://github.com/corei8/chant) repository:
110113

114+
```tex
115+
\newcounter{antiphon}\setcounter{antiphon}{1}
116+
\newcounter{allantiphon}\setcounter{allantiphon}{1}
117+
118+
\newcommand{\buildpsalm}[3]{
119+
\ifnum \value{allantiphon}=10 {\setcounter{antiphon}{1}} \fi
120+
\gresetannotationvalign{bottom}
121+
\greannotation{Ant. \theantiphon}
122+
\gresetgregpath{{./antiphons/}}
123+
\greannotation{#3}
124+
\gregorioscore{#1}
125+
\subsection{Psalm #2.}
126+
\gresetinitiallines{0}
127+
\psalm[ng]{#2}{#3}
128+
\stepcounter{antiphon}
129+
\stepcounter{allantiphon}
130+
\gresetinitiallines{1}
131+
}
132+
```
111133

134+
**NOTE**
112135

136+
Other options will be added as needed/requested (e.g., no color, no psalm
137+
title, numbers, etc.). There are still a few problems with the psalms, as I did
138+
not write the parser myself. Some of the more obscure tones are missing and
139+
there are some unusual renditions of others. I will be working on those soon
140+
and will perhaps be writing my own parser. To my knowledge, the text of the
141+
psalms is perfect, and much work has been done to get rid of some of the
142+
nuances that were present. bringing to my attention any typos that you may find
143+
will be much appreciated.

0 commit comments

Comments
 (0)