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/07/06 11:11:48 UTC
[1/6] incubator-weex-site git commit: Some initial edits
Repository: incubator-weex-site
Updated Branches:
refs/heads/master 9623f301c -> 36e9bb4a3
Some initial edits
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/f6377b12
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/f6377b12
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/f6377b12
Branch: refs/heads/master
Commit: f6377b12287c78e31ec72ab79030d6fd1f6855b5
Parents: c6a572d
Author: Paul Adams <pa...@nmu.edu>
Authored: Wed Jul 4 14:46:13 2018 -0500
Committer: Paul Adams <pa...@nmu.edu>
Committed: Wed Jul 4 14:46:13 2018 -0500
----------------------------------------------------------------------
source/guide/index.md | 60 +++++++++++++++++++++++-----------------------
1 file changed, 30 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/f6377b12/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index de4d3b9..fe24706 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -10,25 +10,25 @@ version: 2.1
## What is Weex?
-> **Weex is a framework for building high-performance mobile applications with modern web development experience.**
+> **Weex is a framework for building high-performance mobile applications with a modern web development experience.**
-Weex dedicates to enable developers to use modern web development experience to build both Android, iOS and web apps with a single codebase. In practice, you can use javascript and modern front-end frameworks to develop mobile apps after integrating the WeexSDK.
+Weex enables developers to use modern web development experience to build Android, iOS, and web apps with a single codebase. In practice, you can use JavaScript and modern front-end frameworks to develop mobile apps after integrating the WeexSDK.
-The structure of Weex is decoupled, the render engines are separated from the syntax layer. Weex doesn't rely on any specific front-end framework, it mainly supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/rax/).
+The structure of Weex is decoupled: the render engines are separated from the syntax layer. Weex does not rely on any specific front-end framework; however, Weex mainly supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/rax/).
-Another primary goal of Weex is to keep up with modern development technologies and platform capabilities both for web and native. Productivity and performance can coexist in Weex. Writing Weex pages feels the same like writing web pages. Rendering Weex pages is just the same as rendering native pages.
+Another primary goal of Weex is to keep up with modern development technologies and platform capabilities both for web and native. Productivity and performance can coexist in Weex. Writing Weex pages feels the same as writing web pages. In fact, rendering Weex pages is the same as rendering native pages.
## Overview
-If you just want to try Weex, You don't need to install anything. There is an [online playground](http://dotwe.org/vue/) of Weex, you can write single page examples on it without any configurations. The source code should be written in Vue.js [single file component](https://vuejs.org/v2/guide/single-file-components.html) syntax (also known as the `*.vue` files), and the render result of the web platform will be displayed in a mocked phone shell.
+If you just want to try Weex, you do not need to install anything. There is an [online playground](http://dotwe.org/vue/) for Weex wherein you can write single page examples without any installation or configuration. The source code should be written in Vue.js [single file component](https://vuejs.org/v2/guide/single-file-components.html) syntax (also known as the `*.vue` files), and the rendered result from editor pane will be displayed in a mock phone shell.
Here is an [example](http://dotwe.org/vue/8da01827631b21150a12dd54d7114380) written in Weex and Vue.js:
-This example renders a word "Yo" in the center of the screen. If you want to preview the rendered result on mobile devices, you need to install the [Weex playground app](/tools/playground.html) or integrate Weex SDK into your own app. Then scan your page's QR code with your playground app or your own app (with the QR scan feature to load scanned URL with Weex SDK), and you will see the rendered result on your device.
+This example renders a word "Yo" in the center of the screen. If you want to preview the rendered result on mobile devices, you need to install the [Weex playground app](/tools/playground.html), or integrate Weex SDK into your own app and scan your page's QR code with your playground app or your own app (with the QR scan feature to load scanned URL with Weex SDK). Thereafter, you will see the rendered result on your device.
-Within the `<template>` of the source code, You must be familiar with the `<div>` which is widely used on the web, and it's also the generic container on Weex. But the `<text>` component is provided by Weex, it's a block-level text container.
+Within the `<template>` of the source code, you will notice the `<div>` element, which is widely used on the web, and is also the generic container in Weex. The `<text>` component, however, is provided by Weex and is a block-level text container.
> The raw text node can only be placed in the `<text>` component, otherwise, it will be ignored.
@@ -36,7 +36,7 @@ Within the `<style>` tag, you can write CSS to describe the styles of a componen
### Native Components
-In the example above, the `<div>` and the `<text>` is rendered into corresponding native views on the mobile device, which is not `HTMLElement`.
+In the example above, the `<div>` and the `<text>` elements are rendered into corresponding native views on the mobile device. As such, they do not implement the `HTMLElement` interface.
@@ -44,33 +44,33 @@ Weex implements render engines both on iOS and Android and provides a group of [
Although the components in Weex look like HTML tags, you are not able to use all of them, instead, you can only use the built-in components and your custom components.
-Under the scene, Weex uses the native widgets. Although Weex emphasize the consistency on each mobile platform, we still embrace the platform's own behavior and UI differences. For example, [the `<switch>` component](http://dotwe.org/vue/d96943452b6708422197c47920903823) may look different on Android and iOS (the appearance on the web simulates iOS).
+Behind the scenes, Weex uses native widgets. Although Weex emphasizes consistency on each mobile platform, we still embrace the platform's own behavior and UI differences. For example, [the `<switch>` component](http://dotwe.org/vue/d96943452b6708422197c47920903823) may look different on Android and iOS (the appearance on the web simulates iOS).
-If you want to use more native component other than the built-in components, you need to implement them on each platform and keep their behaviors to be consistent. The most practical way is to integrate the existing native components to Weex platform.
+If you want to use additional native components, other than the built-in components Weex provides, you need to implement them on each platform and keep their behaviors consistent. The most practical way is to integrate the existing native components to Weex platform. /_ need explanation _/
### Native Modules
-For those features which does not rely on the UI, Weex wraps them into **modules**. You can use `weex.requireModule('xxx')` to require them. It is a way to access native capabilities in javascript, such as network, storage, clipboard, and navigator. For example, you can [use `stream` module to fetch the star count of Vue.js](http://dotwe.org/vue/2ae062b6a04124a35bbe2da3b1e5c07b).
+For those features that do not rely on the UI, Weex wraps them into **modules**. You can use `weex.requireModule('xxx')` to require them. Weex modules provide easy access to native capabilities in JavaScript, such as network, storage, clipboard, and navigator. For example, you can [use `stream` module to fetch the star count of Vue.js](http://dotwe.org/vue/2ae062b6a04124a35bbe2da3b1e5c07b).
-Similarly, Weex also provides a group of [built-in modules](../references/modules/) for basic usage, and supports the integration of the existing native modules to Weex platform.
+Similarly, Weex provides a group of [built-in modules](../references/modules/) for basic usage, and supports the integration of the existing native modules into the Weex platform.
Here are some documents about how to extend native components and native modules for Weex:
-+ [Extend Web Render](./extend-web-render.html)
-+ [Extend Android](./extend-android.html)
-+ [Extend iOS](./extend-ios.html)
+- [Extend Web Render](./extend-web-render.html)
+- [Extend Android](./extend-android.html)
+- [Extend iOS](./extend-ios.html)
### Write Once, Run Everywhere
-Yes, Weex can build for Android, iOS and Web from a single codebase.
+Yes, Weex can build for Android, iOS, and Web from a single codebase.
Using the same source code across different platforms can dramatically increase development productivity and simplify the testing, building, and publishing processes. On this basis, Weex can combine the front-end's packaging and testing process with the mobile's publishing and monitoring system to improve development efficiency.
-> You can read *[How it works](../wiki/index.html)* and *[Design Principles](../wiki/design-principles.html)* to know more about the technologies and ideas behind Weex.
+> You can read _[How it works](../wiki/index.html)_ and _[Design Principles](../wiki/design-principles.html)_ to know more about the technologies and ideas behind Weex.
-Although Weex uses a single codebase, you can still write platform specific codes. Weex provides `weex.config.env` and `WXEnvironment` (they are strictly equal) to get the current runtime environment. You can use `WXEnvironment.platform` to determine which platform the code is running on. Except for the *platform*, `WXEnvironment` also contains other environmental informations, such as *osVersion* and *deviceModel*, refer to *[Weex variable](../references/weex-variable.html)* for the complete list.
+Although Weex uses a single codebase, you can still write platform specific code. Weex provides `weex.config.env` and `WXEnvironment` (they are strictly equal) to get the current runtime environment. You can use `WXEnvironment.platform` to determine which platform the code is running on. Except for the _platform_, `WXEnvironment` contains other information pertaining to environment, such as _osVersion_ and _deviceModel_. Refer to _[Weex variable](../references/weex-variable.html)_ for the complete list.
## Support Multiple Front-End Frameworks
@@ -80,14 +80,14 @@ Weex supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/r
-+ **Vue.js** is a progressive front-end framework for building user interfaces.
-+ **Rax** is a front-end framework with React-compatible APIs.
+- **Vue.js** is a progressive front-end framework for building user interfaces.
+- **Rax** is a front-end framework with React-compatible APIs.
> Vue.js and Rax are already integrated into Weex SDK, you don't need to require them manually.
-However, Vue and Rax are not the only options, it's possible to integrate other your favorite front-end framework into Weex. There is a document *[Extend JS Framework](./extend-js-framework.html)* that describes how to implement it, but the process is still very complicated and tricky. To achieve it, you need to understand many underlying details about the js-native bridge and native render engines.
+However, Vue and Rax are not the only options, it's possible to integrate other your favorite front-end framework into Weex. There is a document _[Extend JS Framework](./extend-js-framework.html)_ that describes how to implement it, but the process is still very complicated and tricky. To achieve it, you need to understand many underlying details about the js-native bridge and native render engines.
-You can read *[Front-End Frameworks](./front-end-frameworks.html)* to learn more details.
+You can read _[Front-End Frameworks](./front-end-frameworks.html)_ to learn more details.
## Create Your Own App
@@ -164,19 +164,19 @@ I believe you've learned the basics of Weex when you reach here. The next step i
If you want to use weex right now:
-+ [Integrate Weex to Your Existing App](./integrate-to-your-app.html)
-+ [Set up Development Environment](./set-up-env.html)
-+ [References](../references/)
+- [Integrate Weex to Your Existing App](./integrate-to-your-app.html)
+- [Set up Development Environment](./set-up-env.html)
+- [References](../references/)
If you want to know the technologies and ideas behind Weex:
-+ [How it Works](../wiki/index.html)
-+ [Design Principles](../wiki/design-principles.html)
-+ [Platform Differences between Weex and Web](../wiki/platform-difference.html)
+- [How it Works](../wiki/index.html)
+- [Design Principles](../wiki/design-principles.html)
+- [Platform Differences between Weex and Web](../wiki/platform-difference.html)
After getting acquainted with Weex, if you want to contribute to make it even better:
-+ [Development Process](../development-process.html)
-+ [How to Contribute](../contributing.html)
+- [Development Process](../development-process.html)
+- [How to Contribute](../contributing.html)
In addition, Weex is a cross-stack technology, developers are also diverse, learn some fundamental knowledge of front-end development, Vue.js, iOS and Android would be especially helpful.
[4/6] incubator-weex-site git commit: make changes requested in PR
Posted by ha...@apache.org.
make changes requested in PR
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/0e06b0bb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/0e06b0bb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/0e06b0bb
Branch: refs/heads/master
Commit: 0e06b0bbb4a5a032cca957628df73b56f864fcd6
Parents: e736947
Author: Paul Adams <pa...@nmu.edu>
Authored: Thu Jul 5 21:07:47 2018 -0500
Committer: Paul Adams <pa...@nmu.edu>
Committed: Thu Jul 5 21:07:47 2018 -0500
----------------------------------------------------------------------
source/guide/index.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/0e06b0bb/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index 396094f..55dfeee 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -26,7 +26,7 @@ Here is an [example](http://dotwe.org/vue/8da01827631b21150a12dd54d7114380) writ
-This example renders a word "Yo" in the center of the screen. If you want to preview the rendered result on mobile devices, you need to install the [Weex playground app](/tools/playground.html), or integrate Weex SDK into your own app and scan your page's QR code with your playground app or your own app (with the QR scan feature to load scanned URL with Weex SDK). Thereafter, you will see the rendered result on your device.
+This example renders a word "Yo" in the center of the screen. If you want to preview the rendered result on a mobile device, you need to install the [Weex playground app](/tools/playground.html), or integrate Weex SDK into your own app and scan your page's QR code with your playground app or your own app (with the QR scan feature to load scanned URL with Weex SDK). Thereafter, you will see the rendered result on your device.
Within the `<template>` of the source code, you will notice the `<div>` element, which is widely used on the web, and is also the generic container in Weex. The `<text>` component, however, is provided by Weex and is a block-level text container.
@@ -48,7 +48,7 @@ Behind the scenes, Weex uses native widgets. Although Weex emphasizes consistenc
-If you want to use additional native components, other than the built-in components Weex provides, you need to implement them on each platform and keep their behaviors consistent. The most practical way is to integrate the existing native components to Weex platform. /_ need explanation _/
+If you want to use additional native components, other than the built-in components provided by Weex, you need to implement them on each platform and keep their behaviors consistent. The most practical way is to integrate the existing native components to Weex platform. /_ need explanation _/
### Native Modules
@@ -64,7 +64,7 @@ Here are some documents about how to extend native components and native modules
### Write Once, Run Everywhere
-Yes, Weex can build for Android, iOS, and Web from a single codebase.
+Yes, Weex can build for Android, iOS, and Web apps from a single codebase.
Using the same source code across different platforms can dramatically increase development productivity and simplify the testing, building, and publishing processes. On this basis, Weex can combine the front-end's packaging and testing process with the mobile's publishing and monitoring system to improve development efficiency.
@@ -124,11 +124,11 @@ npm install
npm start
```
-`npm start` will start a web server on port `8081`. Open `http://localhost:8081` in your browser of choice to see the rendered result of your Weex app. The source code is located in `src/` folder. You can develop it as normal Vue.js project.
+`npm start` will start a web server on port `8081`. Open `http://localhost:8081` in your browser of choice to see the rendered result of your Weex app. The source code is located in `src/` folder. You can develop it as a normal Vue.js project.
-Additionally, you can open `http://localhost:8081/web/preview.html` to preview the rendered result on the web in an iframe. You can also scan the QR code generated on the right using the [Weex playground app](/tools/playground.html) then you'll see the rendered result on the mobile device.
+Additionally, you can open `http://localhost:8081/web/preview.html` to preview the rendered result on the web in an iframe. You can also scan the QR code generated on the right using the[Weex playground app](/tools/playground.html) to see the rendered result on the mobile device.
### Build and Run
[2/6] incubator-weex-site git commit: add more edits
Posted by ha...@apache.org.
add more edits
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/f9fc0523
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/f9fc0523
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/f9fc0523
Branch: refs/heads/master
Commit: f9fc05230347e8f852b81eb5fcfd7b318800c9ce
Parents: f6377b1
Author: Paul Adams <pa...@nmu.edu>
Authored: Wed Jul 4 14:59:32 2018 -0500
Committer: Paul Adams <pa...@nmu.edu>
Committed: Wed Jul 4 14:59:32 2018 -0500
----------------------------------------------------------------------
source/guide/index.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/f9fc0523/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index fe24706..f531faa 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -72,11 +72,11 @@ Using the same source code across different platforms can dramatically increase
Although Weex uses a single codebase, you can still write platform specific code. Weex provides `weex.config.env` and `WXEnvironment` (they are strictly equal) to get the current runtime environment. You can use `WXEnvironment.platform` to determine which platform the code is running on. Except for the _platform_, `WXEnvironment` contains other information pertaining to environment, such as _osVersion_ and _deviceModel_. Refer to _[Weex variable](../references/weex-variable.html)_ for the complete list.
-## Support Multiple Front-End Frameworks
+## Support For Multiple Front-End Frameworks
-Front-end frameworks are syntax layer of weex, they are decoupled from native render engines. Weex does not bind with any specific front-end frameworks, instead, it brings native capabilities to them.
+Front-end frameworks are the syntax layer of Weex; therefore, they are decoupled from native render engines. Weex does not bind with any specific front-end frameworks, instead, Weex brings native capabilities to the front-end.
-Weex supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/rax/) as its internal front-end framework.
+Weex supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/rax/) as its internal front-end frameworks.
@@ -85,17 +85,17 @@ Weex supports [Vue.js](https://vuejs.org/) and [Rax](https://alibaba.github.io/r
> Vue.js and Rax are already integrated into Weex SDK, you don't need to require them manually.
-However, Vue and Rax are not the only options, it's possible to integrate other your favorite front-end framework into Weex. There is a document _[Extend JS Framework](./extend-js-framework.html)_ that describes how to implement it, but the process is still very complicated and tricky. To achieve it, you need to understand many underlying details about the js-native bridge and native render engines.
+However, Vue and Rax are not the only options. It is entirely possible to integrate your favorite front-end framework into Weex! There is a document _[Extend JS Framework](./extend-js-framework.html)_ that describes how to integrate a different front-end framework, the process, however, is still complicated and tricky. You need to understand many underlying details about the js-native bridge and native render engines in order to successfully integrate an alternate front-end framework.
-You can read _[Front-End Frameworks](./front-end-frameworks.html)_ to learn more details.
+You can read _[Front-End Frameworks](./front-end-frameworks.html)_ for more details.
## Create Your Own App
-> The following steps assume you have already known the foundational knowledge of Node.js and npm. If you are not familiar with them, you can visit [https://docs.npmjs.com/](https://docs.npmjs.com/) to learn more about npm.
+> The following steps assume basic knowledge of Node.js and npm. If you are not familiar with them, you can visit [https://docs.npmjs.com/](https://docs.npmjs.com/) to learn more about npm, and [https://nodejs.org/en/docs/](https://nodejs.org/en/docs/) to learn more about Node.js.
-Weex provide a command line tool, the [weex-toolkit](/tools/toolkit.html), to help developers to get start easily. It can help you to create a starter project, setup iOS and Android development environments, debug, install plugins and so on.
+Weex provides a command line tool, the [weex-toolkit](/tools/toolkit.html), to help developers get start easily. The CLI can help you create a starter project, setup iOS and Android development environments, debug, install plugins, and so on.
-Currently, the `weex-toolkit` only supports the creation of Vue.js project. The `rax-cli` maybe helpful if you want to use Rax. Please visit [Rax's official website](https://alibaba.github.io/rax/) for more details.
+Currently, the `weex-toolkit` only supports the creation of Vue.js project. The `rax-cli` may be helpful if you want to use Rax. Please visit [Rax's official website](https://alibaba.github.io/rax/) for more details.
### Set up
[5/6] incubator-weex-site git commit: add space before playground link
Posted by ha...@apache.org.
add space before playground link
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/b6b2d1d6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/b6b2d1d6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/b6b2d1d6
Branch: refs/heads/master
Commit: b6b2d1d6798a8b7eda0a0b7d86e0500b5316a652
Parents: 0e06b0b
Author: Paul Adams <pa...@nmu.edu>
Authored: Fri Jul 6 01:21:33 2018 -0500
Committer: Paul Adams <pa...@nmu.edu>
Committed: Fri Jul 6 01:21:33 2018 -0500
----------------------------------------------------------------------
source/guide/index.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/b6b2d1d6/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index 55dfeee..9a97874 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -128,7 +128,7 @@ npm start
-Additionally, you can open `http://localhost:8081/web/preview.html` to preview the rendered result on the web in an iframe. You can also scan the QR code generated on the right using the[Weex playground app](/tools/playground.html) to see the rendered result on the mobile device.
+Additionally, you can open `http://localhost:8081/web/preview.html` to preview the rendered result on the web in an iframe. You can also scan the QR code generated on the right using the [Weex playground app](/tools/playground.html) to see the rendered result on the mobile device.
### Build and Run
[3/6] incubator-weex-site git commit: final edits
Posted by ha...@apache.org.
final edits
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/e736947d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/e736947d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/e736947d
Branch: refs/heads/master
Commit: e736947d89e8b3873fe3e220fb1ecc39eba3192c
Parents: f9fc052
Author: Paul Adams <pa...@nmu.edu>
Authored: Wed Jul 4 15:26:33 2018 -0500
Committer: Paul Adams <pa...@nmu.edu>
Committed: Wed Jul 4 15:26:33 2018 -0500
----------------------------------------------------------------------
source/guide/index.md | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex-site/blob/e736947d/source/guide/index.md
----------------------------------------------------------------------
diff --git a/source/guide/index.md b/source/guide/index.md
index f531faa..396094f 100644
--- a/source/guide/index.md
+++ b/source/guide/index.md
@@ -99,23 +99,24 @@ Currently, the `weex-toolkit` only supports the creation of Vue.js project. The
### Set up
-Make sure you have already installed the [Node.js](https://nodejs.org/), and then install the `weex-toolkit` globally.
+With [Node.js](https://nodejs.org/) installed, install `weex-toolkit` CLI globally.
```bash
npm install weex-toolkit -g
```
-It will add the `weex` command to your global path. Then you can use `weex create` to create a starter project:
+This will add the `weex` command to your global path, and will allow you to generate new projects with the `weex create <project-name>` command.
+Use `weex create` to create a starter project:
```bash
weex create awesome-app
```
-After doing that, you'll get a standard **Weex + Vue.js** project under the `awesome-app` folder of current path.
+After doing that, a standard **Weex + Vue.js** project will be generated inside the `awesome-app` folder in the current path.
### Develop
-The next step is to navigate into the generated directory, install dependencies, and start.
+The next step is to navigate into the generated directory, install dependencies, and start:
```bash
cd awesome-app
@@ -123,11 +124,11 @@ npm install
npm start
```
-It will start a web server on the `8081` port. You can open `http://localhost:8081` to see the render result on the web. The source code is located in `src/` folder. You can develop it as normal Vue.js project.
+`npm start` will start a web server on port `8081`. Open `http://localhost:8081` in your browser of choice to see the rendered result of your Weex app. The source code is located in `src/` folder. You can develop it as normal Vue.js project.
-Besides, You can also open `http://localhost:8081/web/preview.html` to preview the rendered result for web in iframe. You can also scan the QR code generated on the right using the [Weex playground app](/tools/playground.html) then you'll see the rendered result on the mobile device.
+Additionally, you can open `http://localhost:8081/web/preview.html` to preview the rendered result on the web in an iframe. You can also scan the QR code generated on the right using the [Weex playground app](/tools/playground.html) then you'll see the rendered result on the mobile device.
### Build and Run
@@ -138,9 +139,9 @@ weex platform add ios
weex platform add android
```
-Depends on your network environment, it may take a while, please be patient.
+Depending on your network environment, it may take a while to add them. Please be patient.
-In order to develop the app on your local machine, you need to set up mobile development environments. For iOS, you should install [Xcode](https://developer.apple.com/xcode/). And for Android, you should install [Android Studio](https://developer.android.com/studio/index.html). When the development environments are ready, run the commands below to launch your app on the simulator or the device.
+In order to develop the app on your local machine, you need to set up a mobile development environment. For iOS, you should install [Xcode](https://developer.apple.com/xcode/). For Android, you should install [Android Studio](https://developer.android.com/studio/index.html). When the development environment is ready, run the commands below to launch your app on the simulator or the device.
```bash
weex run ios
@@ -156,11 +157,11 @@ The `weex-toolkit` can also be used to debug your mobile apps. Just run:
weex debug
```
-It'll start debug server and open a web page in Chrome (only support V8 engine). For more technical details of `weex-toolkit`, please refer to the [toolkit document](../tools/toolkit.html).
+`weex debug` will start a debug server and open a web page in Chrome (only support V8 engine). For more technical details of `weex-toolkit`, please refer to the [toolkit document](../tools/toolkit.html).
## Next Steps
-I believe you've learned the basics of Weex when you reach here. The next step is to learn more advanced features of Weex and try it right away.
+At this point, you should have a general understanding of Weex. The next step is to explore and try the advanced features of Weex.
If you want to use weex right now:
@@ -179,4 +180,4 @@ After getting acquainted with Weex, if you want to contribute to make it even be
- [Development Process](../development-process.html)
- [How to Contribute](../contributing.html)
-In addition, Weex is a cross-stack technology, developers are also diverse, learn some fundamental knowledge of front-end development, Vue.js, iOS and Android would be especially helpful.
+Considering that Weex is a cross-stack technology, fundamental knowledge of front-end development, Vue.js, iOS, and Android would be especially helpful.
[6/6] incubator-weex-site git commit: General edits to guide/index.md
file (#172)
Posted by ha...@apache.org.
General edits to guide/index.md file (#172)
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/commit/36e9bb4a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/tree/36e9bb4a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex-site/diff/36e9bb4a
Branch: refs/heads/master
Commit: 36e9bb4a35549400758aa45319fee1a1fb1ec128
Parents: 9623f30 b6b2d1d
Author: Hanks <zh...@gmail.com>
Authored: Fri Jul 6 19:11:26 2018 +0800
Committer: Hanks <zh...@gmail.com>
Committed: Fri Jul 6 19:11:26 2018 +0800
----------------------------------------------------------------------
source/guide/index.md | 95 +++++++++++++++++++++++-----------------------
1 file changed, 48 insertions(+), 47 deletions(-)
----------------------------------------------------------------------