Skip to content

Commit 39c7c26

Browse files
committed
Add BUILDING.md
RND-441
1 parent b35e097 commit 39c7c26

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

BUILDING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
To build **pdfHTML**, [Maven][1] must be installed.
2+
3+
Running install without a profile will generate the **pdfHTML** jar:
4+
```bash
5+
$ mvn clean install \
6+
-Dmaven.test.skip=true \
7+
-Dmaven.javadoc.failOnError=false \
8+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
9+
```
10+
11+
To run the tests, [Ghostscript][2] and [Imagemagick][3] must be installed.
12+
```bash
13+
$ mvn clean install \
14+
-Dmaven.test.failure.ignore=false \
15+
-DgsExec=$(which gs) \
16+
-DcompareExec=$(which compare) \
17+
-Dmaven.javadoc.failOnError=false \
18+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
19+
```
20+
21+
You can use the supplied `Vagrantfile` to get a [Vagrant][4] VM ([Ubuntu][5] 14.04 LTS - Trusty Tahr, with [VirtualBox][6]) with all the required software installed.
22+
```bash
23+
$ vagrant box add ubuntu/trusty64
24+
$ vagrant up
25+
$ vagrant ssh -- \
26+
'cd /vagrant ; mvn clean install -Dmaven.test.skip=true -Dmaven.javadoc.failOnError=false' \
27+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
28+
```
29+
30+
[1]: http://maven.apache.org/
31+
[2]: http://www.ghostscript.com/
32+
[3]: http://www.imagemagick.org/
33+
[4]: https://www.vagrantup.com/
34+
[5]: http://www.ubuntu.com/
35+
[6]: https://www.virtualbox.org/

0 commit comments

Comments
 (0)