Docs

softwaremill · Mar 22, 2019 · 7cf1a49 · 7cf1a49
1 parent 04b3aec
commit 7cf1a49
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -93,14 +93,14 @@ 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) 
+Sidenote for scala 2.12.4 and higher: if you encounter an issue with compiling your project because of 
+a `StackOverflowException` related to [this](https://github.com/scala/bug/issues/10604) scala bug, 
 please increase your stack memory. Example:
 
 ```
 sbt -J-Xss4M clean compile
 ```
+
 ## Contributing
 
 Tapir is an early stage project. Everything might change. All suggestions welcome :)

diff --git a/doc/quickstart.md b/doc/quickstart.md
@@ -37,3 +37,13 @@ using tapir and http4s.
 
 Also check out the simple [runnable example](https://github.com/softwaremill/tapir/blob/master/playground/src/main/scala/tapir/example/BooksExample.scala)
 which is available in the repository.
+
+## StackOverflowException during compilation
+
+Sidenote for scala 2.12.4 and higher: if you encounter an issue with compiling your project because of 
+a `StackOverflowException` related to [this](https://github.com/scala/bug/issues/10604) scala bug, 
+please increase your stack memory. Example:
+
+```
+sbt -J-Xss4M clean compile
+```