aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornuex <[email protected]>2014-04-06 23:51:43 -0400
committernuex <[email protected]>2014-04-06 23:51:43 -0400
commit879108a2aa4e463df1b14830661c0820fcdccb11 (patch)
tree2614d3b766862978523eb49e6dd3f6e71c73c21a /README.md
parent91481adf8d5209f2bf99118c8ff9fd78d1670671 (diff)
downloadrelx-879108a2aa4e463df1b14830661c0820fcdccb11.tar.gz
relx-879108a2aa4e463df1b14830661c0820fcdccb11.tar.bz2
relx-879108a2aa4e463df1b14830661c0820fcdccb11.zip
Windows build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
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
-----------