|
4 | 4 |
|
5 | 5 | Weex is currently in Pre-release Stage.
|
6 | 6 |
|
7 |
| -We agrees that you may discuss technical information about Weex, except that you may not fork Weex to public repository , write public reviews or post screen shots using information from current repository(https://github.com/alibaba/weex) , redistribute weex within any form. |
| 7 | +We agree that you may discuss technical information about Weex, except that you may not fork Weex to public repository , write public reviews or post screen shots using information from current repository(https://github.com/alibaba/weex) , redistribute weex within any form. |
8 | 8 |
|
9 | 9 |
|
10 | 10 | > A framework for building Mobile cross-platform UI.
|
11 | 11 |
|
12 | 12 | Support Android 4.1 (API 16) and iOS soon. See [Weex website](http://alibaba.github.io/weex/) for more information.
|
13 | 13 |
|
14 |
| -## Meet |
| 14 | +## Meet Weex |
15 | 15 |
|
16 |
| -* Install [Android Playground](http://g.tbcdn.cn/ali-wireless-h5/res/0.0.9/playground.apk). |
| 16 | +* [Install Playground](http://alibaba.github.io/weex/download.html). |
17 | 17 |
|
18 |
| - <img src="http://gtms03.alicdn.com/tps/i3/TB1uH3EMpXXXXcmXFXXdtp1PXXX-476-476.png" width="160" height="160" > |
| 18 | +## Use Weex |
19 | 19 |
|
20 |
| -## Use |
21 |
| - |
22 |
| -* See [Tutorial](http://alibaba.github.io/weex/doc/tutorial). |
23 |
| -* See [Weex Documentation](http://alibaba.github.io/weex/doc) for more information. |
| 20 | +* See [Tutorial](https://github.com/alibaba/weex/blob/dev/doc/tutorial.md). |
| 21 | +* See [Weex Documentation](https://github.com/alibaba/weex/blob/dev/doc/INSTALL.md) for more information. |
24 | 22 |
|
25 | 23 | ### Android
|
26 | 24 |
|
27 | 25 | 0. Prerequisites
|
28 | 26 | 0. Install [Node.js](http://nodejs.org/) 4.0+
|
29 |
| - 0. `npm install` to install project |
| 27 | + 0. Under project root |
| 28 | + 0. `npm install`, install project |
| 29 | + 0. `./start` |
30 | 30 | 0. Install [Android Environment](http://developer.android.com/training/basics/firstapp/index.html)
|
31 |
| -0. Run playground |
32 |
| - 0. `npm run serve` |
33 |
| - 0. In Android Studio |
34 |
| - 0. Open `android/playground` |
35 |
| - 0. In `app/java/com.alibaba.weex/WXMainActivity`, modify `CURRENT_IP` to your local IP |
36 |
| - 0. Click <img src="http://gtms04.alicdn.com/tps/i4/TB1wCcqMpXXXXakXpXX3G7tGXXX-34-44.png" height="16" > (`Run` button) |
37 |
| -0. Add an example |
38 |
| - 0. `npm run watch` |
39 |
| - 0. In `examples`, add a file `newExample.we` |
40 |
| - 0. In `examples/index.we`, add an item `{name: 'newExample', title: 'New Example'}` for array `data.cases` |
| 31 | +0. Run playground, In Android Studio |
| 32 | + 0. Open `android/playground` |
| 33 | + 0. In `app/java/com.alibaba.weex/WXMainActivity`, modify `CURRENT_IP` to your local IP |
| 34 | + 0. Click <img src="http://gtms04.alicdn.com/tps/i4/TB1wCcqMpXXXXakXpXX3G7tGXXX-34-44.png" height="16" > (`Run` button) |
| 35 | +0. [Add an example](./examples/README.md#add-an-example) |
41 | 36 |
|
42 | 37 | ## Scripts
|
43 | 38 |
|
44 |
| -**clean `*.js` in the folders of `examples/build` and `test/build`** |
45 |
| -```shell |
46 |
| -npm run clean |
47 |
| -``` |
48 |
| - |
49 |
| -**transform `*.we` in the folders of `examples` & `test`** |
50 |
| -```shell |
51 |
| -npm run transform |
52 |
| -``` |
53 |
| - |
54 |
| -**build js-framework and h5-render** |
55 |
| -```shell |
56 |
| -npm run build |
57 |
| -``` |
58 |
| - |
59 |
| -**copy the builded files to `playground`** |
60 |
| -```shell |
61 |
| -npm run copy |
62 |
| -``` |
63 |
| - |
64 |
| -**npm run clean && npm run build** |
65 |
| -```shell |
66 |
| -npm run dev |
67 |
| -``` |
68 |
| - |
69 |
| -**will run a file server at `12581` port** |
70 |
| -```shell |
71 |
| -npm run serve |
72 |
| -``` |
73 |
| - |
74 |
| -**will run a watcher for `*.we` changed** |
75 |
| -```shell |
76 |
| -npm run watch |
77 |
| -``` |
78 |
| - |
79 |
| -**will run test under js-framework and h5-render** |
80 |
| -```shell |
81 |
| -npm run ci |
82 |
| -``` |
| 39 | +See [SCRIPTS.md](SCRIPTS.md) for more information. |
| 40 | + |
| 41 | +## For Windows |
| 42 | + |
| 43 | +Please install [Git for Windows](https://git-scm.com/download/win) or [Cygwin](https://www.cygwin.com/). |
| 44 | + |
| 45 | +## FAQ |
| 46 | + |
| 47 | +See [FAQ](./doc/faq.md) for more information. |
83 | 48 |
|
84 | 49 | ## Contributing
|
85 | 50 |
|
86 |
| -See [Weex Contributing Guide](./CONTRIBUTING.md). |
| 51 | +See [Weex Contributing Guide](./CONTRIBUTING.md) for more information. |
0 commit comments