Skip to content

Commit f5a2658

Browse files
committed
update README
1 parent a319d20 commit f5a2658

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Build Status](https://travis-ci.org/wzshiming/pic2ascii.svg?branch=master)](https://travis-ci.org/wzshiming/pic2ascii)
44
[![Go Report Card](https://goreportcard.com/badge/github.com/wzshiming/pic2ascii)](https://goreportcard.com/report/github.com/wzshiming/pic2ascii)
5+
[![Docker Automated build](https://img.shields.io/docker/automated/wzshiming/pic2ascii.svg?maxAge=2592000?style=plastic)](https://github.com/wzshiming/pic2ascii/)
56
[![GitHub license](https://img.shields.io/github/license/wzshiming/pic2ascii.svg)](https://github.com/wzshiming/pic2ascii/blob/master/LICENSE)
67

78
- [English](https://github.com/wzshiming/pic2ascii/blob/master/README.md)
@@ -11,12 +12,24 @@
1112

1213
Go version >= 1.5.
1314

15+
FFmpeg version >= 3.X
16+
1417
## Download and install
1518

1619
``` shell
20+
# Not support video
1721
go get -u -v github.com/wzshiming/pic2ascii/cmd/pic2ascii
22+
23+
# Support video (Depends ffmpeg)
24+
go get -tags=support_video -u -v github.com/wzshiming/pic2ascii/cmd/pic2ascii
1825
```
1926

27+
or
28+
29+
[Download releases](https://github.com/wzshiming/pic2ascii/releases) Not support video (Compile or use docker image if necessary.)
30+
31+
[Docker image](https://hub.docker.com/r/wzshiming/pic2ascii/) Support video
32+
2033
## Usage
2134

2235
### example1
@@ -92,6 +105,24 @@ MMKu. ."kWMNx' . =WMMMMNk:..
92105
93106
```
94107

108+
## Support formats
109+
110+
- Picture
111+
- [x] jpeg
112+
- [x] png
113+
- [x] bmp
114+
- [x] tiff
115+
- [x] webp
116+
- [x] gif
117+
118+
- Video (Depends ffmpeg)
119+
- [x] mp4
120+
- [x] ts
121+
- [x] rtmp
122+
- [x] rtsp
123+
- [x] flv
124+
- [x] aac
125+
95126
## License
96127

97128
Pouch is licensed under the MIT License. See [LICENSE](https://github.com/wzshiming/pic2ascii/blob/master/LICENSE) for the full license text.

README_cn.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Build Status](https://travis-ci.org/wzshiming/pic2ascii.svg?branch=master)](https://travis-ci.org/wzshiming/pic2ascii)
44
[![Go Report Card](https://goreportcard.com/badge/github.com/wzshiming/pic2ascii)](https://goreportcard.com/report/github.com/wzshiming/pic2ascii)
5+
[![Docker Automated build](https://img.shields.io/docker/automated/wzshiming/pic2ascii.svg?maxAge=2592000?style=plastic)](https://github.com/wzshiming/pic2ascii/)
56
[![GitHub license](https://img.shields.io/github/license/wzshiming/pic2ascii.svg)](https://github.com/wzshiming/pic2ascii/blob/master/LICENSE)
67

78
- [English](https://github.com/wzshiming/pic2ascii/blob/master/README.md)
@@ -11,12 +12,24 @@
1112

1213
Go 版本 >= 1.5.
1314

15+
FFmpeg 版本 >= 3.X
16+
1417
## 下载与安装
1518

1619
``` shell
20+
# 不支持视频
1721
go get -u -v github.com/wzshiming/pic2ascii/cmd/pic2ascii
22+
23+
# 支持视频(依赖 ffmpeg)
24+
go get -tags=support_video -u -v github.com/wzshiming/pic2ascii/cmd/pic2ascii
1825
```
1926

27+
28+
29+
[Download releases](https://github.com/wzshiming/pic2ascii/releases) 不支持视频(如有需要请自行编译或使用 docker 镜像.)
30+
31+
[Docker image](https://hub.docker.com/r/wzshiming/pic2ascii/) 支持视频
32+
2033
## 用法
2134

2235
### 示例1
@@ -92,6 +105,24 @@ MMKu. ."kWMNx' . =WMMMMNk:..
92105
93106
```
94107

108+
## 支持格式
109+
110+
- 图片
111+
- [x] jpeg
112+
- [x] png
113+
- [x] bmp
114+
- [x] tiff
115+
- [x] webp
116+
- [x] gif
117+
118+
- 视频 (依赖 ffmpeg)
119+
- [x] mp4
120+
- [x] ts
121+
- [x] rtmp
122+
- [x] rtsp
123+
- [x] flv
124+
- [x] aac
125+
95126
## 许可证
96127

97128
软包根据MIT License。有关完整的许可证文本,请参阅[LICENSE](https://github.com/wzshiming/pic2ascii/blob/master/LICENSE)

0 commit comments

Comments
 (0)