Skip to content

Commit b68cc1f

Browse files
jbrainsdanieldietrich
authored andcommitted
Describe possible build problems and how to overcome them. (vavr-io#2322)
1 parent 950a5d8 commit b68cc1f

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Vavr needs to be compiled with **jdk 1.8.0_40** at a minimum, which fixes many t
44

55
[Fork](https://help.github.com/articles/fork-a-repo) the GitHub, send a [pull request](https://help.github.com/articles/using-pull-requests) and keep your fork in [sync](https://help.github.com/articles/syncing-a-fork/) with the upstream repository.
66

7+
## Building
8+
9+
Some people have reported problems building Vavr on their platforms. You should be able to build Vavr with Java 8 or above, but on some platforms (operating systems or distributions), you might need to choose from a narrower range of versions of Java, Maven, and the Scala plugin for Maven. See [this issue](https://github.com/vavr-io/vavr/issues/2321) for details.
10+
711
## IDE
812

913
We use recent IDE version to develop Vavr. IntelliJ IDEA is preferred over Eclipse.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ Currently, only basic microbenchmarks are available. To run:
3939
mvn clean test -P benchmark -pl vavr-benchmark
4040
```
4141

42+
### Contributing
43+
44+
A small number of users have reported problems building Vavr. Read "How to Contribute" (CONTRIBUTING.md) for details.
45+
4246
---
4347

4448
If you like Vavr you can support us by donating.

0 commit comments

Comments
 (0)