|
1 | | -# 🌳 AutoPDF |
| 1 | +# 📄 AutoPDF |
2 | 2 |
|
3 | | -**AutoPDF is a tool that helps you create PDF documents from templates.** |
| 3 | +<div align="center"> |
| 4 | +<img src="./.gitassets/logo.png" alt="AutoPDF Logo" width="300" height="300" class="center"> |
4 | 5 |
|
5 | | -Simple. Neat. Fast. Powerful. |
| 6 | +[](https://godoc.org/github.com/BuddhiLW/AutoPDF) [](LICENSE) |
6 | 7 |
|
7 | | -Perfect for creating professional, customizable PDF documents as a service. |
| 8 | +**A tool that creates PDFs, using LaTeX and Go's templating syntax.** |
| 9 | +</div> |
8 | 10 |
|
9 | | -Like, Share, Subscribe, and Hit the Bell Icon! |
10 | 11 |
|
11 | | -(Please do mention the software usage in your projects, products, etc.) |
12 | 12 |
|
13 | | -[](LICENSE) |
| 13 | +- :zap: Simple. Neat. Fast. Powerful. :zap: |
| 14 | +- Perfect for creating professional, customizable PDF documents. |
| 15 | +- *Leverages* the most powerful PDF document generator: $\LaTeX$. |
14 | 16 |
|
15 | | -Built with ❤️ by [BuddhiLW](https://github.com/BuddhiLW) |
16 | | -Using [Bonzai](https://github.com/rwxrob/bonzai) |
| 17 | +> *Like, Share, Subscribe, and Hit the Bell Icon!* |
| 18 | +
|
| 19 | +**Please do mention the software usage in your projects, products, etc.** |
| 20 | + |
| 21 | + |
| 22 | +Built with ❤️ by [BuddhiLW](https://github.com/BuddhiLW). Using [Bonzai](https://github.com/rwxrob/bonzai) 🌳. |
17 | 23 |
|
18 | 24 | ## Install |
19 | 25 |
|
20 | | -``` bash |
| 26 | +```bash |
21 | 27 | go install github.com/BuddhiLW/AutoPDF/cmd/autopdf@latest |
22 | 28 | ``` |
23 | 29 |
|
24 | 30 | ## Usage |
25 | 31 |
|
26 | 32 | ### Build |
27 | 33 |
|
28 | | -``` bash |
| 34 | +```bash |
29 | 35 | cd ./internal/autopdf/test-data |
30 | 36 |
|
31 | 37 | autopdf build template.tex config.yaml # [optional: `clean`] |
32 | 38 | file out/output.pdf |
33 | 39 | ``` |
| 40 | + |
34 | 41 | Should output: |
35 | 42 |
|
36 | 43 | ``` |
37 | | -file out/output.pdf |
| 44 | +file out/output.pdf |
38 | 45 | out/output.pdf: PDF document, version 1.5 |
39 | 46 | ``` |
40 | 47 |
|
41 | 48 | ### Clean up auxiliary files |
42 | 49 |
|
43 | | -``` bash |
| 50 | +```bash |
44 | 51 | autopdf clean <path-to-output-directory> |
45 | 52 | ``` |
46 | 53 |
|
47 | 54 | Or, more conveniently, you can use the `build` command with the `clean` flag: |
48 | 55 |
|
49 | | -``` bash |
| 56 | +```bash |
50 | 57 | autopdf build template.tex config.yaml clean |
51 | 58 | ``` |
52 | 59 |
|
53 | | - |
54 | 60 | ## License |
55 | 61 |
|
56 | 62 | This project is licensed under the [Apache License 2.0](LICENSE). |
57 | | - |
58 | | - |
|
0 commit comments