hpdf

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# hpdf [![.github/workflows/ci.yml](https://github.com/threez/hpdf.cr/actions/workflows/ci.yml/badge.svg)](https://github.com/threez/hpdf.cr/actions/workflows/ci.yml) [![https://threez.github.io/hpdf.cr/](https://badgen.net/badge/api/documentation/green)](https://threez.github.io/hpdf.cr/)

Shard to create PDF documents with crystal using [libharu/libhpdf](https://github.com/libharu/libharu/).

Example renderings of the example files and specs: 

[![montage](montage.png)](pdfs).

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml
   dependencies:
     hpdf:
       github: threez/hpdf.cr
   ```

2. Run `shards install`

## Usage

```crystal
require "hpdf"

pdf = Hpdf::Doc.build do
  page do
    draw_rectangle 50, 50, width - 100, height - 110

    text Hpdf::Base14::Helvetica, 70 do
      text_out :center, :center, "Hello World"
    end
  end
end

pdf.save_to_file "hello.pdf"

```

## C library dependencies

Requires **libharu ≥ 2.4.6**, which depends on **libpng** and **zlib**.

- **macOS** — `brew install libharu` (ships ≥ 2.4.6)
- **Alpine** — `apk add libharu` (check version; build from submodule if < 2.4.6)
- **Arch Linux** — `pacman -S libharu`
- **FreeBSD** — `pkg install libharu`
- **OpenBSD** — `pkg_add libharu`
- **Debian/Ubuntu** — `apt` ships libhpdf 2.3 (too old). Build from the bundled submodule instead:

  ```bash
  git clone https://github.com/threez/hpdf.cr
  cd hpdf.cr
  make libharu   # initialises submodule and builds a static lib; no system install needed
  ```

  The shard's `@[Link]` detects and links the built static library automatically.

## Development

Use the examples to write demos. Read about *libharu* here:

* http://libharu.sourceforge.net/index.html
* https://github.com/libharu/libharu/wiki

## Contributing

1. Fork it (https://github.com/threez/hpdf.cr/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Vincent Landgraf](https://github.com/threez) - creator and maintainer