Merge pull request #56 from BBartosz/readme-update

Update readme with note about compilation problem
softwaremill · Mar 20, 2019 · 9dbad48 · 9dbad48
2 parents 43da272 + a9d3823
commit 9dbad48
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -91,6 +91,16 @@ import tapir._
 
 And finally, type `endpoint.` and see where auto-complete gets you!
 
+---
+
+Sidenote for scala 2.12.4 and higher:
+If you will encounter issue with compiling your project because of 
+StackOverflowException related to [this](https://github.com/scala/bug/issues/10604) 
+please increase your stack memory. Example:
+
+```
+sbt -J-Xss4M clean compile
+```
 ## Contributing
 
 Tapir is an early stage project. Everything might change. All suggestions welcome :)