Updated README with build instructions for Windows (fixes assets syml…

…ink)
wordpress-mobile · Apr 1, 2015 · 23fd043 · 23fd043
1 parent 87c8911
commit 23fd043
Showing 1 changed file with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,27 @@
-# WordPress-Android-Editor
+# WordPress-Android-Editor #
 
-## Introduction
+## Introduction ##
 
 The WordPress-Android-Editor is the text editor used in the [WordPress Android app](https://github.com/wordpress-mobile/WordPress-Android) to create and edit pages & posts. In short it's a simple, straightforward way to visually edit HTML.
 
-## LICENSE
+## Build Instructions ##
+
+Post-checkout instructions for Windows, necessary to convert the assets symlink to a Windows symlink:
+
+From git bash, inside the cloned project root:
+
+    $ rm WordPressEditor/src/main/assets
+    $ git ls-files --deleted -z | git update-index --assume-unchanged -z --stdin
+
+Then, from a Windows command prompt:
+
+    mklink /D [PROJECT_ROOT]\WordPressEditor\src\main\assets %PROJECT_ROOT%\libs\editor-common\assets
+
+Finally, update [PROJECT_ROOT]\.git\info\exclude to ignore the symlink locally:
+
+    # assets symlink
+    WordPressEditor/src/main/assets
+
+## LICENSE ##
 
 This library is licensed under[MIT](LICENSE-MIT)