Skip to content

Commit 23fd043

Browse files
committed
Updated README with build instructions for Windows (fixes assets symlink)
1 parent 87c8911 commit 23fd043

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
1-
# WordPress-Android-Editor
1+
# WordPress-Android-Editor #
22

3-
## Introduction
3+
## Introduction ##
44

55
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.
66

7-
## LICENSE
7+
## Build Instructions ##
8+
9+
Post-checkout instructions for Windows, necessary to convert the assets symlink to a Windows symlink:
10+
11+
From git bash, inside the cloned project root:
12+
13+
$ rm WordPressEditor/src/main/assets
14+
$ git ls-files --deleted -z | git update-index --assume-unchanged -z --stdin
15+
16+
Then, from a Windows command prompt:
17+
18+
mklink /D [PROJECT_ROOT]\WordPressEditor\src\main\assets %PROJECT_ROOT%\libs\editor-common\assets
19+
20+
Finally, update [PROJECT_ROOT]\.git\info\exclude to ignore the symlink locally:
21+
22+
# assets symlink
23+
WordPressEditor/src/main/assets
24+
25+
## LICENSE ##
826

927
This library is licensed under[MIT](LICENSE-MIT)

0 commit comments

Comments
 (0)