Skip to content

Add Building doc #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2020
+24 −1
Merged

Add Building doc #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Please use this Github project for contributing, either through an issue or a Pu

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

- [Scala implementation details](docs/scala_implementation.md)
- [Building](docs/building.md)
- [Project structure](docs/project_structure.md)
- [Scala implementation details](docs/scala_implementation.md)
22 changes: 22 additions & 0 deletions docs/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Building

## Maven toolchain

This project uses Maven Toolchain plugin.

To compile it, you will need to define a toolchain like following in `~/.m2/toolchains.xml`:
```xml
<?xml version="1.0" encoding="UTF8"?>
<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<version>8</version>
<vendor>openjdk</vendor>
</provides>
<configuration>
<jdkHome>/usr/lib/jvm/java-1.8.0-openjdk-amd64</jdkHome>
</configuration>
</toolchain>
</toolchains>
```