Merge pull request #159 from nuex/windows

Windows Support

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
index 96fe0c3..32eaa3b 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,19 @@ This creates the executable `relx`.
 
 Note, if using your own `rebar`, it must at least be > version [2.2.0](https://github.com/rebar/rebar/releases)
 
+Building on Windows
+-------------------
+
+To build relx on Windows you'll need to have rebar installed and the path to
+the rebar binary added to the `PATH` environment variable. To start the build
+use the `bootstrap` batch file:
+
+    c:\> bootstrap
+
+This creates the executable `relx` and the `relx.cmd` shortcut script. Copy
+both of these files to a directory and make the directory available to the
+`PATH` environment variable.
+
 Config File
 -----------