Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maxmeyer committed Feb 1, 2017
1 parent 2030cf2 commit 24665cc
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* 0.1.0
* Add `build`-command into letter generator
* Add `initialize`-command into letter generator
20 changes: 20 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2017 Dennis Günnewig

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Letter Generator

This small tool helps you to generate form letters.


## Usage

### Install

~~~bash
go get github.com/maxmeyer/letter-generator-go
~~~

### Initialize

This will look for `~/.local/share/letter-template/.git` and for a defined
remote repository.

* Setup current directory:

~~~
lg init -V
~~~

* Setup given directory:

~~~
lg init -V my/dir
~~~

### Build

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

~~~
lg build -V
~~~

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

## Copyright

(c) 2017, Dennis Günnewig

0 comments on commit 24665cc

Please sign in to comment.