Skip to content

Commit

Permalink
[doc] update readme and url links (alibaba#3223)
Browse files Browse the repository at this point in the history
Since weex is back to alibaba/weex, update notice files and
url links within README.md and package.json.
  • Loading branch information
Hanks10100 authored Jun 8, 2021
1 parent 801ff05 commit 49bca81
Show file tree
Hide file tree
Showing 17 changed files with 87 additions and 2,723 deletions.
11 changes: 0 additions & 11 deletions .github/CODEOWNERS

This file was deleted.

12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!--
Thanks for using Weex. Github Issue is only used for bur report and please follow the template to report the bug.
Thanks for using Weex. Github Issue is only used for bur report and please follow the template to report the bug.
A good bug report should include the following information:
-->

<!-- Requirements: please go through this checklist before opening a new issue
- * Review the documentation: https://weex.apache.org/index.html
- * Search for existing issues: https://github.com/apache/incubator-weex/issues
- * Use the latest Weex release: https://github.com/apache/incubator-weex/releases -->
- * Review the documentation: http://weex.io
- * Search for existing issues: https://github.com/alibaba/weex/issues
- * Use the latest Weex release: https://github.com/alibaba/weex/releases -->


## Describe the bug
Expand All @@ -16,7 +16,7 @@ A good bug report should include the following information:
<!-- Steps to reproduce the behavior. Include a MCVE using http://dotwe.org/vue , crash stacktrace or share your app project. Please follow the guidelines for providing a MCVE: https://stackoverflow.com/help/mcve -->

## Environment
<!--
<!--
* Device: [e.g. iPhone6]
* OS: [e.g. iOS8.1]
* Version [e.g. 22]
Expand All @@ -29,4 +29,4 @@ A good bug report should include the following information:
<!-- If applicable, add screenshots to help explain your problem. -->

## Additional context
<!-- Add any other context about the problem here.-->
<!-- Add any other context about the problem here.-->
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ assignees: ''
---

<!--
Thanks for using Weex. Github Issue is only used for bur report and please follow the template to report the bug.
Thanks for using Weex. Github Issue is only used for bur report and please follow the template to report the bug.
A good bug report should include the following information:
-->

<!-- Requirements: please go through this checklist before opening a new issue
- * Review the documentation: https://weex.apache.org/index.html
- * Search for existing issues: https://github.com/apache/incubator-weex/issues
- * Use the latest Weex release: https://github.com/apache/incubator-weex/releases -->
- * Review the documentation: http://weex.io
- * Search for existing issues: https://github.com/alibaba/weex/issues
- * Use the latest Weex release: https://github.com/alibaba/weex/releases -->


## Describe the bug
Expand All @@ -26,7 +26,7 @@ A good bug report should include the following information:
<!-- Steps to reproduce the behavior. Include a MCVE using http://dotwe.org/vue , crash stacktrace or share your app project. Please follow the guidelines for providing a MCVE: https://stackoverflow.com/help/mcve -->

## Environment
<!--
<!--
* Device: [e.g. iPhone6]
* OS: [e.g. iOS8.1]
* Version [e.g. 22]
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- First of all, thank you for your contribution!
<!-- First of all, thank you for your contribution!
All PRs should be submitted to master branch -->

<!-- Please follow the template below:
* If you are going to fix a bug of Weex, check whether it already exists in [Github Issue](https://github.com/apache/incubator-weex/issues). If it exists, make sure to write down the link to the corresponding Github issue in the PR you are going to create.
* If you are going to fix a bug of Weex, check whether it already exists in [Github Issue](https://github.com/alibaba/weex/issues). If it exists, make sure to write down the link to the corresponding Github issue in the PR you are going to create.
* If you are going to add a feature for weex, reference the following recommend procedure:
1. Writing a email to [mailing list](https://github.com/apache/incubator-weex/blob/master/CONTRIBUTING.md#mailing-list) to talk about what you'd like to do.
1. Write the corresponding [Documentation](https://github.com/apache/incubator-weex/blob/master/CONTRIBUTING.md#contribute-documentation)
1. Writing a email to [mailing list](https://github.com/alibaba/weex/blob/master/CONTRIBUTING.md#mailing-list) to talk about what you'd like to do.
1. Write the corresponding [Documentation](https://github.com/alibaba/weex/blob/master/CONTRIBUTING.md#contribute-documentation)
1. Write the corresponding Changelogs at the end of changelog.md -->


Expand Down
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
> **NOTICE: This document is outdated and will be rewritten. (WIP)**
# Contributing to Weex

Weex community respects all kinds of contributing, including but not limited to code, documentation, mailing list.

## Table of Content
* [Code of Conduct](#code-of-conduct)
* [Mailing List](#mailing-list)
Expand Down Expand Up @@ -74,11 +78,11 @@ Weex adopts [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/
1. Write the corresponding [document](#contribute-documentation)

### Coding
1. [Fork](https://help.github.com/articles/fork-a-repo/) the Github repository at [https://github.com/apache/incubator-weex](https://github.com/apache/incubator-weex).
1. [Fork](https://help.github.com/articles/fork-a-repo/) the Github repository at [https://github.com/apache/incubator-weex](https://github.com/apache/incubator-weex).
1. Clone the forked repository and create a new branch from `master` to push your commits to.
1. Develop your feature or bug fix in your new branch. Make sure your code meets the [style guidelines](#code-style-guidelines).
1. Add the **License** below to the top of any new file(s) you've added.

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand All @@ -97,13 +101,13 @@ Weex adopts [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/
* specific language governing permissions and limitations
* under the License.
*/

1. Commit all the changes to your branch.

*Tip*:
> If you are writing Java or C++ with Android Studio, **License** will be added to the head of the file automatically.
#### Code Style Guidelines
#### Code Style Guidelines

##### Objective-C

Expand All @@ -127,7 +131,7 @@ Weex adopts [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/

1. One PR should solve only one problem.
1. The PR title should be the form of `[COMPONENT] Summary`:
* `COMPONENT` is one of the mentioned PR categories (android, iOS, JsFm, web, test, etc..).
* `COMPONENT` is one of the mentioned PR categories (android, iOS, JsFm, web, test, etc..).
* `Summary` should be a brief description of your change within one sentence.
1. Content description of PR
* If the PR is about fixing a bug *excluding crash*, a [demo](http://editor.weex.io/) is necessary in code's description.
Expand All @@ -145,4 +149,4 @@ There will be a static check program when you submit a PR,and the following rule
> Reviewing PR may take a great deal of time, please be patient. If your PR doesn't get response over 96 hours, you might send an email to [mailing list](https://weex.apache.org/guide/contribute/how-to-contribute.html#mailing-list) to ask the progress.
# Members and Governance Model
You can find committers, PPMCs and governance model of Weex from [confluence](https://cwiki.apache.org/confluence/x/bFoyBw).
You can find committers, PPMCs and governance model of Weex from [confluence](https://cwiki.apache.org/confluence/x/bFoyBw).
42 changes: 29 additions & 13 deletions HOW-TO-BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ Weex SDK includes 3 different SDKs to use in corresponding system/browser:
* iOS SDK
* [Mobile Web SDK](https://github.com/weexteam/weex-vue-render)

See our [guide in our website](http://weex.apache.org/guide/integrate-to-your-app.html) to learn more about how to integrate Weex SDK into your app.
See our [guide in our website](http://weex.io/guide/integrate-to-your-app.html) to learn more about how to integrate Weex SDK into your app.

# Build Environment

The environment required to build weex is categorized by platforms.

## Android

* JDK `1.8+`
* Android SDK Platform 28
* `ANDROID_HOME` must be configured by using `export ANDROID_HOME=/path_to_sdk`
Expand All @@ -24,6 +26,7 @@ The environment required to build weex is categorized by platforms.
* CMake 3.4.1+

## iOS

* 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)
* XCode Command Tools 8.0+
Expand All @@ -44,16 +47,27 @@ This may take a while. After that, you can look in `dist/`, `android/sdk/build/o

You can build all SDKs with one script as described above, or just build for a single platform step by step.

## Build Javascript Framework
Javascript Framework is required by native SDKs. **So this must be built first.**
Install npm dependencies(You must have node&npm installed):
> `$ npm install --production`
## Build JavaScript Framework

Install npm dependencies (Please install [Node.js](https://nodejs.org/) v8.0.0+ at first):

```bash
npm install
```

Build bundled js framework (include both vue and rax):
```bash
npm run build:jsfm
```

Install build tools:
> `$ npm run install:buildtools`
Build specific js framework:
```bash
npm run build:vue
```

Build the javascript libraries:
> `$ npm run build:source`
```bash
npm run build:rax
```

### Before build Native SDK
Move `min` version to Native SDK folder, which will be used by native SDK build.
Expand All @@ -64,17 +78,19 @@ cp packages/weex-js-framework/index.min.js android/sdk/assets/main.js
```

## Build Android SDK

1. Install the [Android environment](#android).
2. Execute the following command

```
cd android
./gradlew :weex_sdk:clean :weex_sdk:assembleRelease
```
```
cd android
./gradlew :weex_sdk:clean :weex_sdk:assembleRelease
```

3. Output can be found at `android/sdk/build/outputs/aar`

## Build iOS SDK

Execute command below to compile iOS SDK:
> `$ xcodebuild -project ios/sdk/WeexSDK.xcodeproj -target WeexSDK_MTL`
Expand Down
103 changes: 10 additions & 93 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,107 +4,24 @@ A framework for building Mobile cross-platform UI.

[![Build Status](https://travis-ci.org/apache/incubator-weex.svg?branch=master)](https://travis-ci.org/apache/incubator-weex/)

## Join Us
**Join us through [mailing list](https://weex.apache.org/guide/contribute/how-to-contribute.html#mailing-list).**
## Distribution

## Convenience Distribution
**Since 0.28.0, Weex would publish two convince binary in each release for Android, please [read the documentation about the detail](major_change.html).**

**Please take the above link seriously, otherwise you would be able to use the latest version of Weex.**
> Support Android 4.1 (API 16), iOS 9.0+ and WebKit 534.30+.
| platform | status |
| -------- | ------ |
| Android | [sdk ![Download](https://api.bintray.com/packages/weex/Android/sdk/images/download.svg)](https://bintray.com/weex/Android/sdk/_latestVersion) Or [sdk_legacy ![Download](https://api.bintray.com/packages/weex/Android/sdk_legacy/images/download.svg)](https://bintray.com/weex/Android/sdk_legacy/_latestVersion) |
| Android | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.weex/weex_sdk/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.weex/weex_sdk) |
| 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/vue-render-for-apache-weex) | [![npm version](https://badge.fury.io/js/weex-vue-render.svg)](https://www.npmjs.com/package/weex-vue-render) |

Support Android 4.1 (API 16), iOS 9.0+ and WebKit 534.30+.

**FYI: The [mobile web render](https://github.com/weexteam/vue-render-for-apache-weex) is not supported by Apache Weex officially**

## For Windows
First of all, compiling or building Weex from Windows is not supported officially.

You could install [Git for Windows](https://git-scm.com/download/win) and run all the following commands in git-bash.

Good Luck.

## Meet Weex

* Install [Weex Playground](https://weex.apache.org/tools/playground.html) to see examples we already written.
* If you want to write a demo, install [weex-cli](https://www.npmjs.com/package/weex-toolkit) in [Node.js](http://nodejs.org/) 8.0+ and
* Run `weex init` to generate & start a simple project in an empty folder.
* Follow the instructions in the project README.
* Enjoy it.

## Use Weex

* [Tutorial](http://weex.apache.org/guide/)
* [Documents](http://weex.apache.org/references)

### Android
**You should install [android environment](./HOW-TO-BUILD.md#android) before building.**

You can either build Weex from IDE (*Android Studio*) or command line.

#### Build From Android Studio
1. Open `android` directory in Android Studio.
2. Run `git submodule update --init --remote` in `android` directory if this is the first time you try to run Weex.

#### Build From Command Line
Please read [How To Build](./HOW-TO-BUILD.md) for detail.

### iOS
**You should install [iOS environment](./HOW-TO-BUILD.md#ios) before building.**

You can either build Weex from IDE (*XCode*) or command line.

#### Build From XCode
* 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'
```
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.

#### Build From Command Line
Please read [How To Build](./HOW-TO-BUILD.md) for detail.

### Mobile Web
**Vue Render for Apache Weex is a third party plugin, and not developed nor maintained by Apache Weex.**
| [Web](https://github.com/weexteam/weex-vue-render) | [![npm](https://badge.fury.io/js/weex-vue-render.svg)](https://www.npmjs.com/package/weex-vue-render) |

see [Vue Render for Apache Weex](https://github.com/weexteam/vue-render-for-apache-weex).
## Build from Source

## Third part plugin
There is a third party plugin provides for debugging purpose.
* [Android](https://weex.apache.org/guide/debug/integrate-devtool-to-android.html)
* [iOS](https://weex.apache.org/guide/debug/integrate-devtool-to-ios.html)
[How To Build](./HOW_TO_BUILD.md)

You can also view this page for all [third party plugin](https://weex.apache.org/tools).
## Contribution

## Weex Community
* [Mailing List](https://weex.apache.org/guide/contribute/how-to-contribute.html#mailing-list) Weex Mailing List, where most discussion happens.
* [StackOverflow](http://stackoverflow.com/questions/tagged/weex): Ask questions about Weex.
* [SegmentFault (cn)](https://segmentfault.com/t/weex): 中文交流与讨论
* [Telegram Russian Community Group](https://telegram.me/weex_ru)
Please read [Contributing Guide](./CONTRIBUTING.md) for more information.

### Contributing
## License

See [Weex Contributing Guide](./CONTRIBUTING.md) for more information.
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
10 changes: 2 additions & 8 deletions WeexSDK.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Pod::Spec.new do |s|
A framework for building Mobile cross-platform UI
DESC

s.homepage = "https://github.com/apache/incubator-weex"
s.homepage = "https://github.com/alibaba/weex"
s.license = {
:type => 'Apache-2.0'
}
Expand All @@ -22,12 +22,6 @@ Pod::Spec.new do |s|
s.platform = :ios
s.ios.deployment_target = '9.0'

# use for public
# s.source = {
# :git => 'https://github.com/apache/incubator-weex.git',
# :tag => #{s.version}
# }

# use for playground
s.source = { :path => '.' }

Expand Down Expand Up @@ -125,7 +119,7 @@ Pod::Spec.new do |s|
'GCC_PREPROCESSOR_DEFINITIONS' => 'OS_IOS=1' }

s.frameworks = 'CoreMedia','MediaPlayer','AVFoundation','AVKit','JavaScriptCore','GLKit','OpenGLES','CoreText','QuartzCore','CoreGraphics'

s.libraries = 'c++'

end
Loading

0 comments on commit 49bca81

Please sign in to comment.