summaryrefslogtreecommitdiff
path: root/README.md
blob: ff0ebda6eba5f4e47835d2d2b7f63742aef1eee8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# MSM PackingSlip Generator

This tool takes as input a YAML document ("manifest") which shows what a
customer ordered, and generates a PDF of the packing slip. The packing slip
is intended to be printed and shipped to the customer along with the
merchandise.

The YAML manifest refers only to "catalog numbers," so you must also provide
a catalog file which maps catalog numbers to all the other metadata about
the goods you're selling (human-readable description, unit price, etc.)


## Example YAML manifest


```yaml
---
order_no: 1
order_date: "2023-09-29"

items:
  -
    catalog_no: 3
    qty: 2
  -
    catalog_no: 5
    qty: 1

bill_to: |
  Perseus Floof
  57345 Calamity Court
  Goalla Gumpy, RI 19535
  United States

ship_to: |
  Boris M. Q. Felicity III
  10 Decimal Way
  Charming, WY 79345
  United States
```


## License

This software is released by Magenta Stripe Media under the terms of a
2-clause BSD-style license. Please refer to the LICENSE document.