summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSeth Tisue <seth@tisue.net>2015-10-08 13:10:14 -0400
committerSeth Tisue <seth@tisue.net>2015-10-08 13:10:14 -0400
commit543e739bf9ff0f512e71f6d971c87187f7a6f4d3 (patch)
tree6a92c51bf7e1766e61aafbedcb43075680d3b955 /README.md
parent52cf99af83e75b8e15c93542dca8bd24a214ce0d (diff)
downloadscala-543e739bf9ff0f512e71f6d971c87187f7a6f4d3.tar.gz
scala-543e739bf9ff0f512e71f6d971c87187f7a6f4d3.tar.bz2
scala-543e739bf9ff0f512e71f6d971c87187f7a6f4d3.zip
add note to readme about Windows build
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index c8f3f206c4..d5d85cbaa3 100644
--- a/README.md
+++ b/README.md
@@ -76,6 +76,8 @@ scala/
You'll need a Java SDK (6 or newer), Apache Ant (version 1.9.0 or above), and curl (for `./pull-binary-libs.sh`).
+Mac OS X and Linux work. Windows may work if you use Cygwin. (Community help with keeping the build working on Windows is appreciated.)
+
## Git Hygiene
As git history is forever, we take great pride in the quality of the commits we merge into the repository. The title of your commit will be read hundreds (of thousands? :-)) of times, so it pays off to spend just a little bit more time to polish it, making it descriptive and concise. Please take a minute to read the advice [most projects agree on](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), and stick to 72 or fewer characters for the first line, wrapping subsequent ones at 80 (at most).