Move to YARD for documentation generation.
[Akkordarbeit.git] / README.rdoc
bloba2b23bac7d1902dc93724dcd0d6fb0ea30089221
1 = Abstract
3 Akkordarbeit[https://JoergWMittag.GitHub.Com/akkordarbeit/] is a 
4 program for formatting simple leadsheets in a simplified ChordPro 
5 format to various other formats such as HTML or plaintext.
7 ---
9 = What
11 This program converts leadsheets and songsheets written in a 
12 subset of the widely used 
13 ChordPro[http://Vromans.Org/johan/projects/Chordii/chordpro/] 
14 file format into other formats, more suitable for printing or 
15 publishing. Currently, the supported formats are plaintext and 
16 HTML.
18 Akkordarbeit only supports a very small subset of the ChordPro 
19 format. Specifically, it only supports song lines, no directives.
21 = Installation
23         gem install JoergWMittag-akkordarbeit
25 = Usage
27         akkordarbeit -f html -i input.cho -o output.html
29 = Acknowledgements
31 Akkordarbeit would not be possible without the original Chord 
32 utility.
34 = License
36 Akkordarbeit is licensed under the {MIT X11 License}[https://GitHub.Com/JoergWMittag/Akkordarbeit/blob/master/LICENSE.rdoc].
38 :include: LICENSE.rdoc