https://github.com/feduxorg/letter-generator

Generate letters in PDF format based on LaTex-Templates
https://github.com/feduxorg/letter-generator

generator go golang latex letter

Last synced: 22 days ago
JSON representation

Generate letters in PDF format based on LaTex-Templates

• Host: GitHub
• URL: https://github.com/feduxorg/letter-generator
• Owner: feduxorg
• License: mit
• Created: 2017-08-03T21:19:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T06:02:19.000Z (7 months ago)
• Last Synced: 2024-11-15T10:30:08.939Z (2 months ago)
• Topics: generator, go, golang, latex, letter
• Language: Go
• Homepage:
• Size: 124 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# The Letter Generator in Go

This tool helps you to generate form letters, based on a template for

multiple recipients.

## Setup

* Install the letter generator

  ~~~bash

  go get -u github.com/feduxorg/letter-generator

  ~~~

* Install LaTeX

  Make sure, you installed LaTeX on your system. This tools uses

  `pdflatex` in the background to generate the PDF from your letter template.

## Usage

### Initialize directory for your letter

* (optional) Install examples

  ~~~bash

  # Clone repository

  git clone https://github.com/feduxorg/letter-generator /tmp/letter-generator

  # Either create your own templates or use our examples

  ## Move examples to the correct place

  mv /tmp/letter-generator/docs/examples/en/ ~/.local/share/letter-template/

  ## or

  mv /tmp/letter-generator/docs/examples/de/ ~/.local/share/letter-template/

  # setup git repository

  cd ~/.local/share/letter-template/

  git init

  git add .

  git commit -m "Init"

  ~~~

* Create directory for your letter

  ~~~bash

  mkdir my-letter

  cd my-letter

  ~~~

* Setup directory

  * – with local repository `~/.local/share/letter-template/.git`

    ~~~bash

    # current directory

    lg init -V

    # given directory

    lg init -V my/dir

    ~~~

  * – with remote repository `https://github.com/xxxxx/xxxx.git`

    ~~~bash

    lg init -V --template-source `https://github.com/xxxxx/xxxx.git`

    ~~~

### Build letters

This will build the letters. Make sure you've initialized the directory before.

~~~bash

lg build -V

~~~

After building letters, you will find a directory called `letters` in the

current directory.

## Development

### Build letter-generator from its sources

~~~

bin/setup

bin/build

bin/test

~~~

### Central configuration file for helper scripts

Configuration for helper scripts is done via environment variables in [`env.sh`](env.sh).

### Install locally after build

~~~bash

make install

~~~

### Upgrade git2go / libgit2

See https://github.com/libgit2/git2go#master-branch-or-vendored-static-linking

for more information about this. 

If you plan to upgrade your version, you need to modify a few files.

1. Update version for "libgit2" in `env.sh`

  ~~~bash

: ${LIBGIT2_TAG:=release-1.5}

  ~~~

2. Update version of "git2go" in `go.mod`

  ~~~bash

  # [...]

  github.com/libgit2/git2go/v34 v34.0.0

  # [...]

  replace github.com/libgit2/git2go/v34 => ./ext_deps/git2go

  ~~~

## Copyright

(c) 2021, Dennis Günnewig