You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by erisu <gi...@git.apache.org> on 2018/06/24 13:19:58 UTC
[GitHub] incubator-weex pull request #1288: Improved README.md
GitHub user erisu opened a pull request:
https://github.com/apache/incubator-weex/pull/1288
Improved README.md
This PR:
- Bumped Node.js 4+ reference to 6+ to match with weex-toolkit's actual engine requirement.
- Centralized Prerequisites for All Platforms into its own section.
- Wording improvements
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/erisu/incubator-weex improve-readme
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-weex/pull/1288.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1288
----
commit fb7b65fe773734cc57672ac6c93bd378fd109ebe
Author: エリス <el...@...>
Date: 2018-06-24T12:24:06Z
Improved README.md
- Bumped Node.js 4+ reference to 6+ to match with weex-toolkit's actual engine requirement.
- Centralized Prerequisites for All Platforms into its own section.
- Wording improvements
----
---
[GitHub] incubator-weex pull request #1288: Improved README.md
Posted by erisu <gi...@git.apache.org>.
Github user erisu commented on a diff in the pull request:
https://github.com/apache/incubator-weex/pull/1288#discussion_r198102709
--- Diff: README.md ---
@@ -10,80 +10,78 @@ A framework for building Mobile cross-platform UI.
| iOS | [![Pod version](https://badge.fury.io/co/WeexSDK.svg)](https://cocoapods.org/pods/WeexSDK) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) |
| [Mobile Web](https://github.com/weexteam/weex-vue-render) | [![npm version](https://badge.fury.io/js/weex-html5.svg)](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
Please ***INSTALL [Git for Windows](https://git-scm.com/download/win)*** and run all the following commands in git-bash.
## 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/) 6.0+.
--- End diff --
@Hanks10100 Thanks for pointing it out. I will update it.
I thought originally, it was referencing the Node.js requirement of `weex-toolkit` which is currently `>=6.0` in master, not the entire `incubator-weex`.
https://github.com/weexteam/weex-toolkit/blob/master/package.json#L13
---
[GitHub] incubator-weex pull request #1288: Improved README.md
Posted by Hanks10100 <gi...@git.apache.org>.
Github user Hanks10100 commented on a diff in the pull request:
https://github.com/apache/incubator-weex/pull/1288#discussion_r198059444
--- Diff: README.md ---
@@ -10,80 +10,78 @@ A framework for building Mobile cross-platform UI.
| iOS | [![Pod version](https://badge.fury.io/co/WeexSDK.svg)](https://cocoapods.org/pods/WeexSDK) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) |
| [Mobile Web](https://github.com/weexteam/weex-vue-render) | [![npm version](https://badge.fury.io/js/weex-html5.svg)](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
Please ***INSTALL [Git for Windows](https://git-scm.com/download/win)*** and run all the following commands in git-bash.
## 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/) 6.0+.
--- End diff --
Since the `engine` property in the [`package.json`](https://github.com/apache/incubator-weex/blob/0.18.0/package.json#L34-L36) is `>=8`, we can declare the version of node as `8.0+`.
---
[GitHub] incubator-weex issue #1288: Improved README.md
Posted by weex-bot <gi...@git.apache.org>.
Github user weex-bot commented on the issue:
https://github.com/apache/incubator-weex/pull/1288
<!--
0 failure:
1 warning: No Changelog chan...
1 messages
-->
<table>
<thead>
<tr>
<th width="50"></th>
<th width="100%" data-danger-table="true">Warnings</th>
</tr>
</thead>
<tbody><tr>
<td>:warning:</td>
<td>No Changelog changes!</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th width="50"></th>
<th width="100%" data-danger-table="true">Messages</th>
</tr>
</thead>
<tbody><tr>
<td>:book:</td>
<td>danger test finished.</td>
</tr>
</tbody>
</table>
<p align="right">
Generated by :no_entry_sign: <a href="http://github.com/danger/danger-js/">dangerJS</a>
</p>
---
[GitHub] incubator-weex issue #1288: Improved README.md
Posted by erisu <gi...@git.apache.org>.
Github user erisu commented on the issue:
https://github.com/apache/incubator-weex/pull/1288
@Hanks10100 I have updated the node version requirement. Please let me know if you see anything else.
---
[GitHub] incubator-weex pull request #1288: Improved README.md
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-weex/pull/1288
---