Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xanderjakeq committed Jun 17, 2024
1 parent b65b3aa commit 841267f
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,13 @@ is the custom height (10 by default). everything else will be kept

paragraphs should be written in one line

### cli
write the input file and save it as `whatever.txt`
### server
download a release (should be at the top right on github >^)

go to the bin server and double click the server binary. copy paste this
link on your browser: http://localhost:3000

### input format
format:
```
template_file_name
Expand All @@ -77,15 +81,32 @@ to add a nickname to use instead of the firstname, do `firstname|nickname
lastname` on the `[full_names]` line. if the firstname or nickname is more than
one word, use underscore like `John_Paul` or `Mr._J`

click generate and the output folder should open.

### cli
write the input file and save it as `whatever.txt`

the same import format applies

generate pdfs
```
./path_to_letter_generator_executable ./whatever.txt
```

output pdfs are placed in a directory named `output_today's_date/`
output pdfs are placed in a directory named `pdf_output/date/`

## dev

install: go, make, air
```
go mod download #install deps
make air #run air to watch server files
make tailwind #run tailwind cli and watch for file changes in server dir
make build #build cli and server binaries
make export_server #build and copy binary and static files to `output/` dir
```

[maroto](https://github.com/johnfercher/maroto)
- generate pdfs

Expand Down

0 comments on commit 841267f

Please sign in to comment.