You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by ha...@apache.org on 2018/06/26 15:46:04 UTC
incubator-weex git commit: [doc] Improved README.md (resolve #1288)
Repository: incubator-weex
Updated Branches:
refs/heads/master d0cf4337e -> 9ffdd044c
[doc] Improved README.md (resolve #1288)
- Bumped Node.js 4+ reference to 8+ to match with incubator-weex's engine requirement.
- Centralized Prerequisites for All Platforms into its own section.
- Wording improvements
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex/commit/9ffdd044
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex/tree/9ffdd044
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex/diff/9ffdd044
Branch: refs/heads/master
Commit: 9ffdd044cdb910869c0977b55368c7213c2f5091
Parents: d0cf433
Author: エリス <el...@gmail.com>
Authored: Sun Jun 24 21:24:06 2018 +0900
Committer: Hanks <zh...@gmail.com>
Committed: Tue Jun 26 23:44:55 2018 +0800
----------------------------------------------------------------------
README.md | 84 ++++++++++++++++++++++++++++------------------------------
1 file changed, 41 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/9ffdd044/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index dff2129..2deabec 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Weex
-A framework for building Mobile cross-platform UI.
+A framework for building mobile cross-platform UI.
[](https://circleci.com/gh/alibaba/weex/tree/dev)
@@ -10,7 +10,7 @@ A framework for building Mobile cross-platform UI.
| iOS | [](https://cocoapods.org/pods/WeexSDK) [](https://github.com/Carthage/Carthage) |
| [Mobile Web](https://github.com/weexteam/weex-vue-render) | [](https://www.npmjs.com/package/weex-vue-render) |
-Support Android 4.1 (API 16), iOS 8.0+ and WebKit 534.30+.
+Supports Android 4.1 (API 16), iOS 8.0+ and WebKit 534.30+.
## For Windows
@@ -18,10 +18,11 @@ Please ***INSTALL [Git for Windows](https://git-scm.com/download/win)*** and run
## Meet Weex
-* Install [Weex Playground App](https://weex.apache.org/tools/playground.html) to see examples we already written.
-* If you want to write a demo, install [weex-toolkit](https://www.npmjs.com/package/weex-toolkit) in [Node.js](http://nodejs.org/) 4.0+ and
-* Run `weex init` to generate & start a simple project in an empty folder.
-* Follow the instructions in the project README.
+* Install [Weex Playground App](https://weex.apache.org/tools/playground.html) to see existing examples.
+* Create your own examples by install [weex-toolkit](https://www.npmjs.com/package/weex-toolkit) with [Node.js](http://nodejs.org/) 8.0+.
+ * Run `weex init` command on an empty folder to generate & start a new project.
+ * Follow the instructions from in the project's README file.
+* [Add an example](./examples/README.md#add-an-example).
* Enjoy it.
## Use Weex
@@ -29,61 +30,58 @@ Please ***INSTALL [Git for Windows](https://git-scm.com/download/win)*** and run
* [Tutorial](http://weex.apache.org/guide/)
* [Documents](http://weex.apache.org/references)
-### Android
+### Prerequisites for All Platforms
+
+* Install [Node.js](http://nodejs.org/) 8.0+
+* Under the project's root directory, in terminal:
+ * Run `npm install` command, to install project dependencies.
+ * Run `./start` command.
+### Android
* Prerequisites
- * Install [Node.js](http://nodejs.org/) 4.0+
- * Under project root
- * `npm install`, install project
- * `./start`
- * Install [Android Environment](http://developer.android.com/training/basics/firstapp/index.html)
-* Run playground, In Android Studio
+ * Install [Android Environment](http://developer.android.com/training/basics/firstapp/index.html)
+* Run playground in Android Studio
* Open `android/playground`
* In `app/java/com.alibaba.weex/IndexActivity`, modify `CURRENT_IP` to your local IP
* Click <img src="http://gtms04.alicdn.com/tps/i4/TB1wCcqMpXXXXakXpXX3G7tGXXX-34-44.png" height="16" > (`Run` button)
-* [Add an example](./examples/README.md#add-an-example)
#### Runtime
-On Android Platform , Weex code is executed in [weex_v8core](https://github.com/alibaba/weex_v8core) which is based on Google V8 JavaScript engine.
+On Android Platform, Weex code is executed in [weex_v8core](https://github.com/alibaba/weex_v8core) which is based on Google V8 JavaScript engine.
### iOS
-* run playground
- * Prerequisites
- * Install [Node.js](http://nodejs.org/) 4.0+
- * Under project root
- * `npm install`, install project
- * `./start`
- * Install [iOS Environment](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppStoreDistributionTutorial/Setup/Setup.html)
- * Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
- * Run playground
- * `cd ios/playground`
- * `pod install`
- * Open `WeexDemo.xcworkspace` in Xcode
- * Click <img src="http://img1.tbcdn.cn/L1/461/1/5470b677a2f2eaaecf412cc55eeae062dbc275f9" height="16" > (`Run` button) or use default shortcut `cmd + r` in Xcode
- * If you want to run the demo on your device, don't need to modify `CURRENT_IP` manually. ~~In `DemoDefine.h`(you can search this file by Xcode default shortcut `cmd + shift + o`), modify `CURRENT_IP` to your local IP~~
- * [Add an example](./examples/README.md#add-an-example)
-* integrate to your application
+* Prerequisites
+ * Install [iOS Environment](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppStoreDistributionTutorial/Setup/Setup.html)
+ * Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
+
+* Run playground
+ * `cd ios/playground`
+ * `pod install`
+ * Open `WeexDemo.xcworkspace` in Xcode
+ * Click <img src="http://img1.tbcdn.cn/L1/461/1/5470b677a2f2eaaecf412cc55eeae062dbc275f9" height="16" > (`Run` button) or use default shortcut `cmd + r` in Xcode
+ * If you want to run the demo on your device, don't need to modify `CURRENT_IP` manually. ~~In `DemoDefine.h`(you can search this file by Xcode default shortcut `cmd + shift + o`), modify `CURRENT_IP` to your local IP~~
+
+* Integrate to your application
- **[CocoaPods](https://cocoapods.org)**
-
- Add the following line to your Podfile:
- ```
- pod 'WeexSDK'
- ```
+
+ Add the following line to your Podfile:
+ ```
+ pod 'WeexSDK'
+ ```
run `pod install`
-
+
- **[Carthage](https://github.com/carthage/carthage)**
-
+
Add the following line to your Cartfile:
- ```
- github "apache/incubator-weex"
- ```
- Run `carthage update`, and you should now have the latest version of `WeexSDK` in your `Carthage` folder.
+ ```
+ github "apache/incubator-weex"
+ ```
+ Run `carthage update`, and you should now have the latest version of `WeexSDK` in your `Carthage` folder.
### Mobile Web
-see [weex-vue-render](https://github.com/weexteam/weex-vue-render).
+See [weex-vue-render](https://github.com/weexteam/weex-vue-render).
## Scripts