Skip to content

Commit

Permalink
more documnetaion clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
gutschilla committed Jun 18, 2019
1 parent d53ba6a commit 0ef5009
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
6 changes: 5 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Changes

- 0.5.5
- improved documentation on `prefer_system_executable: true` for chrome
- improved documentation on `prefer_system_executable: true` for chrome.
Thanks to [Martin Richer](https://github.com/richeterre) for rasining this
and a [PR](https://github.com/gutschilla/elixir-pdf-generator/pull/55)
- improved documentation on `no_sandbox: true` for chrome in dockerized
environment (running as root)
- clarify that wkhtmltopdf installation snippet is for Ubuntu 18.04.
- log call options as debug info to Logger
- add "knows issues" section to README
- 0.5.4
- **BUGFIX** introduced in 0.5.0 that would crash `PdfGenerator.PathAgent`
when chrome isn't found on path in certain situation. Thanks to
Expand Down
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ encryption) for use in Elixir projects.
# Latest release v0.5.5 on 2019-06-18

- 0.5.5
- improved documentation on `prefer_system_executable: true` for chrome
- improved documentation on `prefer_system_executable: true` for chrome.
Thanks to [Martin Richer](https://github.com/richeterre) for rasining this
and a [PR](https://github.com/gutschilla/elixir-pdf-generator/pull/55)
- improved documentation on `no_sandbox: true` for chrome in dockerized
environment (running as root)
- clarify that wkhtmltopdf installation snippet is for Ubuntu 18.04.
- log call options as debug info to Logger
- add "knows issues" section to README

For a proper changelog, see [CHANGES](CHANGES.md)

Expand Down Expand Up @@ -57,14 +61,17 @@ those generated with wkhtmltopdf.
2. Download wkhtmltopdf and place it in your $PATH. Current binaries can be
found here: http://wkhtmltopdf.org/downloads.html

For the impatient (Ubuntu18):
For the impatient (Ubuntu 18.04 Bionic Beaver):

```
apt-get -y install xfonts-base xfonts-75dpi \
&& wget https://downloads.wkhtmltopdf.org/0.12/0.12.5/wkhtmltox_0.12.5-1.bionic_amd64.deb \
&& dpkg -i wkhtmltox_0.12.5-1.bionic_amd64.deb
```

For other distributions, refer to http://wkhtmltopdf.org/downloads.html – For
example, replace `bionic` with `xenial` if you're on Ubuntu 16.04.

## optional dependencies

3. _optional:_ Install `xvfb` (shouldn't be required with the binary mentioned above):
Expand Down Expand Up @@ -241,3 +248,11 @@ config :pdf_generator,

For more info, read the [docs on hex](http://hexdocs.pm/pdf_generator) or issue
`h PdfGenerator` in your iex shell.

# Known issues

Unfortunately, with Elixir 1.7+ `System.cmd` seems to pass parameters
differently to the environment than it did before, now requiring shell options
like `--foo=bar` to be split up as `["--foo", "bar"]`. Since this library makes
heavy use of command line parameters, I intend to bump the Elixir version to 1.7
for that reason, starting with v0.6.0.

0 comments on commit 0ef5009

Please sign in to comment.