Commit 57b83693 authored by Bryan Housel's avatar Bryan Housel

Add fixWinSymlinks.bat and instructions to README

(closes #2574)
parent 24b5b047
* text=auto
*.bat eol=crlf
......@@ -47,10 +47,11 @@ Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on
To run the current development version of iD on your own computer:
1. Create a local `git clone` of the project, then `cd` into the project folder
2. Run `npm install`
3. Run `make`
4. Start a local web server, e.g. `python -m SimpleHTTPServer`
5. Open `http://localhost:8000/` in a web browser
2. (Windows Only) Run `fixWinSymlinks.bat`. This script will prompt for Administrator rights. see also:
3. Run `npm install`
4. Run `make`
5. Start a local web server, e.g. `python -m SimpleHTTPServer`
6. Open `http://localhost:8000/` in a web browser
For guidance on building a packaged version, running tests, and contributing to
development, see [](
@echo For converting Git symlink files to Windows file symlinks.
@echo * Run in repository root as Administrator.
@echo * Handling of folder symlinks is not implemented.
@echo * Intended for windows versions Vista and above (Win 7,8)
@echo Thanks to:
@echo v1.02 (c) 2015 Robert Benko (Quazistax), License: MIT
@echo off
pushd "%~dp0"
setlocal EnableDelayedExpansion
call :raiseUACIfNotAdmin || exit /B 1
for /f "tokens=3,*" %%e in ('git ls-files -s ^| findstr /R /C:"^120000"') do (
call :processFirstLine %%f
REM pause
goto :eof
@echo FILE: %1
dir "%~f1" | find "<SYMLINK>" >NUL && (
@echo FILE already is a symlink
goto :eof
for /f "usebackq tokens=*" %%l in ("%~f1") do (
@echo LINK TO: %%l
del "%~f1"
if not !ERRORLEVEL! == 0 (
@echo FAILED: del
goto :eof
call :expandRelative linkto "%1" "%%l"
mklink "%~f1" "!linkto!"
if not !ERRORLEVEL! == 0 (
@echo FAILED: mklink
@echo reverting deletion...
git checkout -- "%~f1"
goto :eof
git update-index --assume-unchanged "%1"
if not !ERRORLEVEL! == 0 (
@echo FAILED: git update-index --assume-unchanged
goto :eof
goto :eof
goto :eof
:: param1 = result variable
:: param2 = reference path from which relative will be resolved
:: param3 = relative path
pushd .
cd "%~dp2"
set %1=%~f3
goto :eof
:: Quick test for Windows generation: UAC aware or not ; all OS before NT4 ignored for simplicity
:: Original from:
(ver | findstr /IL "5." > NUL || ver | findstr /IL "4." > NUL) && (
@echo ERROR: Symlinks are not supported on this version of Windows.
exit /B 1
:: Test if Admin
call net session >NUL 2>&1
if not !ERRORLEVEL! == 0 (
:: Start batch again with UAC
echo Set UAC = CreateObject^("Shell.Application"^) > "%temp%\getadmin.vbs"
echo UAC.ShellExecute "cmd.exe", "/K ""cd /d %~dp0 && %~s0""", "%~dp0", "runas", 1 >> "%temp%\getadmin.vbs"
@echo Requesting administrative privileges...
del "%temp%\getadmin.vbs"
exit /B 2
exit /B 0
goto :eof
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment