Covergen
How To Install It
git clone https://github.com/WaldoHatesYou/Covergen.git
cd Covergen
chmod +x covergen
To test Covergen, compile the sample cover letter by writing the following.
./covergen example/test.coverletter
If the test.coverletter.output file has the following text, then Covergen is correctly installed.
To whom it may concern,
I completed two programming courses in Java when I was in high school
Best regards,
Javed Nissar
Tutorial
First, start by creating a new directory and entering the directory.
mkdir example
cd example
Then, write the following in example.json.
{
"awesome":"I am awesome"
}
After that, write the following and save it in tutorial.coverletter
import example
To whom it may concern,
{example[awesome]}
Best regards,
Javed Nissar
The following command will compile the .coverletter file depicted above to a .coverletter.output file.
./covergen tutorial.coverletter
The previous command will create a file named tutorial.coverletter.output that should contain the following text
To whom it may concern,
I am awesome
Best regards,
Javed Nissar
Explanation of Cover Letter Template Format
All cover letters have the .coverletter file extension, these cover letters are written so that they have two types of lines, import lines and text lines.
import example #an import line
Hello world #a text line
Import lines are for importing new data and text lines have any variables within them replaced with data obtained from the imports. This feature is demonstrated below.
import example #an import line
I don't but I do like {example[favorite]}.
In this example, {example[favorite]}
refers to the data contained in the
JSON file example at the key 'favorite'. This JSON file could be written as
follows.
{
"favorite":"JSON"
}