Skip to content

Commit 22d4817

Browse files
committed
doc: Update README and LICENSE
1 parent 721feeb commit 22d4817

File tree

3 files changed

+54
-9
lines changed

3 files changed

+54
-9
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Jiehui Liu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@
44

55
![cover_cn](assets/cover_cn.jpg)
66

7-
用平常说话的方式搜索本地相册中的图片——完全离线本地运行!
7+
🔍 用平常说话的方式搜索本地相册中的图片——无需联网、本地运行
88

9+
借助图搜,您可以用平常说话的方式来搜索手机里的照片。例如:“草丛中的猫咪”、“桌上的笔记本电脑”、“粉色衣服的女孩”,等等。
910

11+
- 完全免费,没有任何内购
12+
- 对图像的索引和搜索完全离线运行,无需担心隐私安全
13+
- 支持中英双语搜索
14+
- 为移动设备专门优化的模型,上万张照片也能1秒呈现结果
15+
- 只需要首次使用时进行索引,后续即可立刻搜索
1016

1117
## 获取方式
1218

1319
<a href='https://play.google.com/store/apps/details?id=me.grey.picquery&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img style="width:130px" src='./assets/google-play-badge-cn.png'/></a>
1420

1521
- Google Play: 搜索 “图搜” 或 “PicQuery”,或点击上方链接
16-
1722
- 从本仓库下载:[Release](https://github.com/greyovo/PicQuery/releases)
1823

1924
**其他方式:**
@@ -22,13 +27,13 @@
2227
- 镜像站加速:将 [Release](https://github.com/greyovo/PicQuery/releases) 中的文件下载链接复制到 [GitHub Proxy](https://ghproxy.com/) 中下载
2328
- 国内应用市场(待上线)
2429

25-
> iOS 用户请使用 [“寻隐”](https://apps.apple.com/cn/app/寻隐-用句子描述找照片/id1664361663),它是图搜的灵感来源,由 [@mazzzystar](https://github.com/mazzzystar) 开发并开源。
30+
> 🍎 iOS 用户请使用 [“寻隐”](https://apps.apple.com/cn/app/寻隐-用句子描述找照片/id1664361663),它是图搜的灵感来源,由 [@mazzzystar](https://github.com/mazzzystar) 开发并开源。
2631
2732

2833

2934
## 实现原理
3035

31-
> 感谢 [@mazzzystar](https://github.com/mazzzystar)[@Young-Flash](https://github.com/Young-Flash) 在本应用开发过程中的帮助,讨论过程可 [在此查看](https://github.com/mazzzystar/Queryable/issues/12)
36+
> 感谢 [@mazzzystar](https://github.com/mazzzystar)[@Young-Flash](https://github.com/Young-Flash) 在本应用开发过程中的[协助与讨论](https://github.com/mazzzystar/Queryable/issues/12)
3237
3338
本应用基于 OpenAI 的 [CLIP 模型](https://github.com/openai/CLIP) 实现。
3439

@@ -43,7 +48,7 @@
4348
- `clip-image-encoder-quant-int8.onnx`
4449
- `clip-text-encoder-quant-int8.onnx`
4550

46-
将它们放入 `app\src\main\assets` 中,然后就可以构建和运行了
51+
将它们放入 `app\src\main\assets` 中,即可构建和运行
4752

4853

4954

@@ -52,4 +57,10 @@
5257

5358
- [mazzzystar/Queryable](https://github.com/mazzzystar/Queryable)
5459
- [Young-Flash](https://github.com/Young-Flash)
55-
- [IacobIonut01/Gallery](https://github.com/IacobIonut01/Gallery)
60+
- [IacobIonut01/Gallery](https://github.com/IacobIonut01/Gallery)
61+
62+
63+
64+
## 开源协议
65+
66+
本项目基于 MIT 许可协议开源,保留所有权利。

README_en.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@
44

55
![cover_en](assets/cover_en.jpg)
66

7-
Search for your local images in the way you normally talk, running completely offline
7+
🔍 Search for your local images with natural language, running completely offline. For example, "a laptop on the desk", "sunset by the sea", "kitty in the grass", and so on.
8+
9+
- Totally free, NO in-app purchases
10+
- Support both English and Chinese
11+
- Indexing and searching of images works completely offline without worrying about privacy
12+
- Show results in less than 1 second when searcing for 8,000+ photos
13+
- Wait for indexing on the first time you launch, and search immediately afterwards
14+
15+
816

917
## Installation
1018

@@ -13,11 +21,11 @@ Search for your local images in the way you normally talk, running completely of
1321
- Google Play - Search for “PicQuery”,or click the button above
1422
- Download APK from [Release](https://github.com/greyovo/PicQuery/releases)
1523

16-
> For iOS, please refer to *[Queryable](https://apps.apple.com/us/app/queryable-find-photo-by-text/id1661598353)*, the inspiration behind this application, developed and open-sourced by [@mazzzystar](https://github.com/mazzzystar).
24+
> 🍎 For iOS users, please refer to *[Queryable](https://apps.apple.com/us/app/queryable-find-photo-by-text/id1661598353)*, the inspiration behind this application, developed and open-sourced by [@mazzzystar](https://github.com/mazzzystar).
1725
1826
## Implementation
1927

20-
> Thanks to [@mazzzystar](https://github.com/mazzzystar) and [@Young-Flash](https://github.com/Young-Flash) for their assistance during the development of this application. The discussion can be viewed [here](https://github.com/mazzzystar/Queryable/issues/12).
28+
> Thanks to [@mazzzystar](https://github.com/mazzzystar) and [@Young-Flash](https://github.com/Young-Flash) for their assistance during the development. The discussion can be viewed [here](https://github.com/mazzzystar/Queryable/issues/12).
2129
2230
*PicQuery* is powered by OpenAI's [CLIP model](https://github.com/openai/CLIP).
2331

@@ -38,3 +46,8 @@ Put them into `app\src\main\assets` and you're ready to build and run.
3846
- [mazzzystar/Queryable](https://github.com/mazzzystar/Queryable)
3947
- [Young-Flash](https://github.com/Young-Flash)
4048
- [IacobIonut01/Gallery](https://github.com/IacobIonut01/Gallery)
49+
50+
## License
51+
52+
This project is open source under MIT license. All rights reserved.
53+

0 commit comments

Comments
 (0)