README.md (2012B)
1 # lorid 2 3 lorid is a command line program that implements the [chordpro standard](https://chordpro.org/chordpro). 4 5 It is written on Linux but looking at the dependencies you could possibly run 6 it on other systems too. 7 8 ## Dependencies 9 10 Currently I don't distribute an independent binary of lorid. 11 You have to install the dependencies and build it yourself. 12 13 With the commands below you build the dependencies also yourself. 14 You might want to alternatively install them via a package manager. 15 16 ### pdfio 17 18 Website: `https://www.msweet.org/pdfio/` 19 20 1. Download the archive from `https://github.com/michaelrsweet/pdfio/releases/latest` 21 2. Then inside the project folder run: 22 23 ``` 24 ./configure --enable-shared 25 make 26 make install 27 ``` 28 29 ### toml-c 30 31 Website: `https://github.com/arp242/toml-c` 32 33 ``` 34 git clone https://github.com/arp242/toml-c.git 35 cd toml-c/ 36 make 37 make install 38 ``` 39 40 ### libgrapheme 41 42 Website: `https://libs.suckless.org/libgrapheme/` 43 44 ``` 45 git clone https://git.suckless.org/libgrapheme 46 cd libgrapheme/ 47 ./configure 48 make 49 make install 50 ``` 51 52 ### fontconfig 53 54 Website: `https://www.freedesktop.org/wiki/Software/fontconfig/` 55 56 You probably already have it installed. You can verify that by running: 57 ``` 58 pkg-config --exists fontconfig && echo "Installed" || echo "Not Installed" 59 ``` 60 61 In case it's not installed: 62 63 1. Download the latest release from `https://www.freedesktop.org/software/fontconfig/release/` 64 2. Then inside the project folder run: 65 66 ``` 67 ./configure --sysconfdir=/etc --prefix=/usr --mandir=/usr/share/man 68 make 69 make install 70 ``` 71 72 ## Installation 73 74 You might want to take a look at the Makefile and adjust to your liking. 75 76 ``` 77 ./configure 78 make 79 make install 80 ``` 81 82 ## Usage 83 84 ``` 85 [~] lorid swing-low-sweet-chariot.cho 86 [~] zathura swing-low-sweet-chariot.pdf 87 [~] # start to play and sing... 88 ``` 89 90 ## Documentation 91 92 ``` 93 man 1 lorid 94 man 5 lorid_config 95 ``` 96 97 ## Links 98 99 If you are searching for a feature full, open source, well supported chordpro implementation 100 also checkout the official one at https://chordpro.org.