Skip to content

Commit

Permalink
docs(readme): modify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
txperl committed Mar 13, 2022
1 parent 4d908ae commit ef91e40
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ PixivBiu 是一款不错的 Pixiv **辅助**工具。
* Pixiv 搜索,可免会员按收藏数、人气排序
* 下载原始图片,包括插画、漫画、动图
* 多种下载模式,单、多线程模式以及 aria2 支持
* 筛选图片的宽高、类型、时间、标签等
* 获取用户的作品、收藏夹、关注列表、相关推荐等
* 获取排行榜,包括今日、本周、本月排行等
* 收藏作品、关注等
Expand All @@ -34,7 +35,7 @@ PixivBiu 是一款不错的 Pixiv **辅助**工具。

### Docker

来自 [zzcabc](https://github.com/zzcabc)[Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu) 支持,感谢。
- [Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu) by [zzcabc](https://github.com/zzcabc)

## 文档

Expand Down
9 changes: 5 additions & 4 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ PixivBiu is a nice Pixiv **assistant** tool.
* Pixiv searching, sort by favorites and popularity without membership
* Download original images, including illustrations, comics and motion pictures
* Multiple download modes, single and multi-threaded mode and aria2 support
* Get user's works, favorites, followers, related recommendations, etc.
* Get rankings, including today's, this week's, and this month's rankings, etc.
* Favorite works, followers, etc.
* Filter image width, height, type, time and tags
* Get user's works, favorites, followers, related recommendations
* Get rankings, including today's, week's, and month's rankings
* Favorite works and followers

## Usage

Expand All @@ -34,7 +35,7 @@ They can be downloaded in [GitHub Releases](https://github.com/txperl/PixivBiu/r

### Docker

[Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu) by [zzcabc](https://github.com/zzcabc), thanks!
- [Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu) by [zzcabc](https://github.com/zzcabc)

## Document

Expand Down
19 changes: 9 additions & 10 deletions README_JA.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ PixivBiuはPixivのための**補助的な**ツールです。
* お気に入り数(会員の除外可)順や人気順でのPixiv検索
* イラスト/漫画/うごイラを含む画像のオリジナル画質でのダウンロード
* シングル/マルチスレッドや[aria2](https://github.com/aria2/aria2)などでのダウンロード
* 画像の幅、高さ、タイプ、時間、ラベルなどをフィルタリングします
* 指定したユーザの投稿作品/ブックマーク/フォロワー/関連するおすすめなどの取得
* 当日/週間/月間別などでのランキングの取得
* ブックマークやフォロー中のユーザなどの取得
Expand All @@ -21,22 +22,20 @@ PixivBiuはPixivのための**補助的な**ツールです。
* 依存ライブラリのインストール: `pip install -r requirements.txt`
* [Flask](https://github.com/pallets/flask), [requests](https://github.com/psf/requests), [PyYAML](https://github.com/yaml/pyyaml), [Pillow](https://github.com/python-pillow/Pillow), [PixivPy](https://github.com/upbit/pixivpy), [PySocks](https://github.com/Anorov/PySocks)
* `./config.yml` の設定 (例: [デフォルトの設定ファイル](./app/config/biu_default.yml))
* 実行: `python main.py`
* 実行: `python main.py`
* 実行中のページを開く (デフォルトのURL: `http://127.0.0.1:4001/`)

### 実行バイナリから

このプロジェクトは Python 3.7以上で開発されており、実行バイナリのビルドには`PyInstaller`を使用しています。
このプロジェクトは Python 3.7 以上で開発されており、実行バイナリのビルドには `PyInstaller` を使用しています。

Windows版とMac版が利用可能ですが、もし必要であれば自分でビルドを試してください。
Windows 版と macOS 版が利用可能ですが、もし必要であれば自分でビルドを試してください。

ビルド済バイナリは[GitHub Releases](https://github.com/txperl/PixivBiu/releases)もしくは[こちら](https://biu.tls.moe/#/lib/dl)からダウンロードできます。
ビルド済バイナリは [GitHub Releases](https://github.com/txperl/PixivBiu/releases) もしくは[こちら](https://biu.tls.moe/#/lib/dl)からダウンロードできます。

### Dockerから

[Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu)

[zzcabc](https://github.com/zzcabc)に感謝します!
- [Docker_Buildx_PixivBiu](https://github.com/zzcabc/Docker_Buildx_PixivBiu) by [zzcabc](https://github.com/zzcabc)

## ドキュメント

Expand All @@ -56,6 +55,6 @@ Windows版とMac版が利用可能ですが、もし必要であれば自分で

### 告知事項

* 本プログラム (PixivBiu) は学習と交流のみを目的としておりますので、当初の目的を達成した後は自分で削除してください
* 使用後の如何なる問題も作者には一切関係なく、また作者は一切の責任を負いません
* [MITライセンス](https://choosealicense.com/licenses/mit/)です
* 本プログラム (PixivBiu) は学習と交流のみを目的としておりますので、当初の目的を達成した後は自分で削除してください
* 使用後の如何なる問題も作者には一切関係なく、また作者は一切の責任を負いません
* [MITライセンス](https://choosealicense.com/licenses/mit/)です
2 changes: 1 addition & 1 deletion app/config/language/zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ app.common.loginHelper:
hint_intro_step_body: "注意: 程序每次启动时要求获取的 Code 都不同,不可复用之前获取到的,且 Code 不带有引号"
hint_intro_step_1: "1. 访问 %s?%s"
hint_intro_step_1_extra: " (若您无法访问以上网址,可参考此方式 https://github.com/mashirozx/Pixiv-Nginx 进行配置)"
hint_intro_step_2: "2. 打开浏览器的「Dev Console / 开发者工具」,切换至「Network / 网络」标签"
hint_intro_step_2: "2. 打开浏览器的「Dev Console / 开发者工具 / F12」,切换至「Network / 网络」标签"
hint_intro_step_3: "3. 开启「Preserve log / 持续记录」"
hint_intro_step_4: "4. 在「Filter / 筛选」文本框中输入「callback?」"
hint_intro_step_5: "5. 登录您的 Pixiv 账号"
Expand Down

0 comments on commit ef91e40

Please sign in to comment.