Added README.md, example PDF and screenshot.
This commit is contained in:
parent
5df0266bb3
commit
a8b17cf547
37
README.md
Normal file
37
README.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
# Bilingual Invoice Generator
|
||||
|
||||
![Example invoice screenshot](example/invoice_example_screenshot.png)
|
||||
|
||||
[PDF](example/invoice_1_01_02_20.pdf)
|
||||
|
||||
## Build
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
|
||||
### Create config and translation files
|
||||
|
||||
```shell
|
||||
cp config/parameters.yaml.dist config/parameters.yaml.dist
|
||||
cp translations/source.yaml.dist translations/source.yaml
|
||||
cp translations/target.yaml.dist translations/target.yaml
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
# Generate file name
|
||||
./generate 123 ./
|
||||
|
||||
# Use exact file name
|
||||
./generate 123 ./invoice.pdf
|
||||
|
||||
# Set issue date
|
||||
./generate 123 ./ --issue-date 01.01.1970
|
||||
|
||||
# Get help
|
||||
./generate --help
|
||||
```
|
BIN
example/invoice_1_01_02_20.pdf
Normal file
BIN
example/invoice_1_01_02_20.pdf
Normal file
Binary file not shown.
BIN
example/invoice_example_screenshot.png
Normal file
BIN
example/invoice_example_screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 142 KiB |
Loading…
Reference in a new issue