diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f95538..40a3d43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) diff --git a/docs/building.md b/docs/building.md new file mode 100644 index 0000000..087d782 --- /dev/null +++ b/docs/building.md @@ -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 + + + + jdk + + 8 + openjdk + + + /usr/lib/jvm/java-1.8.0-openjdk-amd64 + + + +``` \ No newline at end of file