add Chinese readme

README-zh.md

@@ -0,0 +1,105 @@
+# OpenGL canvas
+
+此项目灵感来源: 
+* Android package com.android.gallery3d.glrenderer 下的源代码
+* [GPUImage](https://github.com/CyberAgent/android-gpuimage)
+* [grafika](https://github.com/google/grafika)
+
+## 功能
+* 提供一个类似Android Canvas类的使用OpenGL来实现绘制的canvasGL。可以像传统自定义View那样直接继承 GLViews, 再使用这个canvas绘制需要的东西。
+* 提供类似 GPUImage 里的Filter的API，可以在使用canvasGL画东西时实现图像处理。
+* 提供的View是继承 GLSurfaceView 或 TextureView 的，可以使用这两种View的特性，特别是TextureView的特性。
+* 另外,因为使用OpenGL在另一线程渲染，所以里面的 GLContinuousView 还提供能够实现高性能的动画的方法。
+
+## 使用要求
+* Android API14 以上(OpenGL ES 2.0 以上)
+
+## 用法
+
+### Gradle dependency
+
+```groovy
+repositories {
+    jcenter()
+    maven { url "https://jitpack.io" }
+}
+
+dependencies {
+    compile 'com.github.ChillingVan:android-openGL-canvas:v1.0.1'
+}
+```
+
+### 样例代码 
+
+自定义一个View.
+```java
+public class MyGLView extends GLView {
+
+    public MyGLView(Context context) {
+        super(context);
+    }
+
+    public MyGLView(Context context, AttributeSet attrs) {
+        super(context, attrs);
+    }
+
+
+    @Override
+    protected void onGLDraw(ICanvasGL canvas) {
+        // draw things with canvas here
+    }
+}
+```
+
+
+![canvas](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/canvas-example.png)
+
+其中, GLContinuouslyView, GLTextureView, GLContinuousTextureView, GLSurfaceTextureProducerView and GLSharedContextView 用法相似.
+
+
+使用CanvasGL实现绘制
+```java
+        canvas.drawBitmap(textBitmap, left, top);
+
+        // transform
+        canvas.save();
+        canvas.rotate(rotateDegree, x, y);
+        canvas.drawBitmap(bitmap, left, top);
+        canvas.restore();
+        // or
+        CanvasGL.BitmapMatrix matrix = new CanvasGL.BitmapMatrix();
+        matrix.postScale(2.1f, 2.1f);
+        matrix.postRotate(90);
+        canvas.drawBitmap(bitmap, matrix);
+
+        // apply filter to the bitmap
+        textureFilter = new ContrastFilter(2.8f);
+        canvas.drawBitmap(bitmap, left, top, textureFilter);
+```
+
+![filters](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/filter_example.png)
+
+
+可以与Camera结合，注意运行样例代码的时候尽量使用真机而不是模拟器。
+![camera](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/camera-example.jpg)
+
+
+
+## 注意事项
+* 每一个View的onGLDraw都运行在自己的线程而非主线程。
+* 目前的Filter没有GPUImage里那么多，后续会陆续增加，如果有需要，参照我的代码自己实现即可，难度不高。
+
+## License
+    Copyright 2012 CyberAgent, Inc.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

README.md

@@ -1,15 +1,17 @@
 # OpenGL canvas
 
+[中文版README](https://github.com/ChillingVan/android-openGL-canvas/blob/master/README-zh.md) 
+
 Idea from: 
 * Codes of Android source code under package com.android.gallery3d.glrenderer
 * [GPUImage](https://github.com/CyberAgent/android-gpuimage)
 * [grafika](https://github.com/google/grafika)
 
 ## Features
-* This canvas provide similar API as android canvas. And there are GLViews that can be extended to custom your own view to draw things with OpenGL.
+* The canvasGL provides similar API as android canvas. And there are GLViews that can be extended to custom your own view to draw things with OpenGL.
 * Similar to the filters of GPUImage, you can apply the filter to the bitmap draw into the GLViews. 
 * Provides GLViews that using GLSurfaceView and TextureView. 
-* The GLContinuousView can provide high performance continuous rendering animation.
+* The GLContinuousView can provide high performance continuous rendering animation because it uses openGL to draw in its own thread.
 
 ## Requirements
 * Android API14 or higher (OpenGL ES 2.0)
@@ -51,8 +53,8 @@ public class MyGLView extends GLView {
 }
 ```
 
-![camera](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/camera-example.jpg)
 
+![canvas](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/canvas-example.png)
 
 The Usage of GLContinuouslyView, GLTextureView, GLContinuousTextureView, GLSurfaceTextureProducerView and GLSharedContextView is similar.
 
@@ -78,11 +80,17 @@ Using canvas to draw
 ```
 
 ![filters](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/filter_example.png)
-![canvas](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/canvas-example.png)
 
 
 And can be used with camera, just run the camera sample code on a real device(not in emulator) to see what will happen.
 
+![camera](https://github.com/ChillingVan/android-openGL-canvas/raw/master/screenshots/camera-example.jpg)
+
+
+## Notice
+* The onGLDraw method in GLView runs in its own thread but not the main thread. 
+* I haven't implemented all the filters in GPUImage. I will add more later. If you need, you can take my code as example to implement your filter. It is simple.
+
 ## License
     Copyright 2012 CyberAgent, Inc.