Skip to content

Commit a5281d4

Browse files
authored
Merge pull request #41 from cucumber/doc-about-building
Add Building doc
2 parents a89d320 + 6ba600b commit a5281d4

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ Please use this Github project for contributing, either through an issue or a Pu
1212

1313
These pages aim to help Cucumber Scala developers understand the codebase.
1414

15-
- [Scala implementation details](docs/scala_implementation.md)
15+
- [Building](docs/building.md)
1616
- [Project structure](docs/project_structure.md)
17+
- [Scala implementation details](docs/scala_implementation.md)

docs/building.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Building
2+
3+
## Maven toolchain
4+
5+
This project uses Maven Toolchain plugin.
6+
7+
To compile it, you will need to define a toolchain like following in `~/.m2/toolchains.xml`:
8+
```xml
9+
<?xml version="1.0" encoding="UTF8"?>
10+
<toolchains>
11+
<toolchain>
12+
<type>jdk</type>
13+
<provides>
14+
<version>8</version>
15+
<vendor>openjdk</vendor>
16+
</provides>
17+
<configuration>
18+
<jdkHome>/usr/lib/jvm/java-1.8.0-openjdk-amd64</jdkHome>
19+
</configuration>
20+
</toolchain>
21+
</toolchains>
22+
```

0 commit comments

Comments
 (0)