Browse Source

update README.md

hexleo 5 years ago
parent
commit
7776cb9750
2 changed files with 65 additions and 0 deletions
  1. 2 0
      README.md
  2. 63 0
      README_en.md

+ 2 - 0
README.md

@@ -2,6 +2,8 @@
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
 
+简体中文 | [English](./README_en.md)
+
 VAP(Video Animation Player)是企鹅电竞开发,用于播放酷炫动画的实现方案。
 
 * 相比Webp, Apng动图方案,具有高压缩率(素材更小)、硬件解码(解码更快)的优点

+ 63 - 0
README_en.md

@@ -0,0 +1,63 @@
+# VAP
+
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
+
+VAP(Video Animation Player) is a fantastic animation player. It can play video with alpha channel.
+
+* Compared with Webp or Apng animation, it has the advantages of high compression rate (smaller material) and hardware decoding.
+
+
+* Compared with Lottie, it can achieve more complex animation effects (such as particle effects)
+
+
+More detail: [Introduction.md](./Introduction.md)
+
+
+Demo show:
+
+[Web demo](https://egame.qq.com/vap)
+
+![](./images/anim1.gif)
+
+And VAP can also merge custom attributes (such as user name, avatar) into the animation.
+
+![](./images/anim2.gif)
+
+
+
+## Performance
+
+
+-|file size|decoder|effects support
+---|---|---|---
+Lottie|can't generate|software decoder|not support particle effects
+GIF|4.6M|software decoder|only support 8 bit color format
+Apng|10.6M|software decoder|all support
+Webp|9.2M|software decoder|all support
+mp4|1.5M|hardware decoder|not support alpha channel
+VAP|***1.5M***|***hardware decoder***|***all support***
+
+
+More detail: [Introduction.md](./Introduction.md)
+
+
+## Platform support
+
+Platform:[Android](./Android), [iOS](./iOS), [web](./web). 
+
+Generation tool:[VapTool](./tool)
+
+
+
+## Issue
+
+If you have some problems with VAP, you can post issues. Developer will check often.
+
+## FAQ
+
+[FAQ](https://github.com/Tencent/vap/wiki/FAQ)
+
+## License
+
+VAP is under the MIT license. See the [LICENSE](./LICENSE.txt) file for details.