Skip to content

Commit

Permalink
wip: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lijy91 committed Jun 22, 2024
1 parent fc89b09 commit 9935223
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 38 deletions.
27 changes: 10 additions & 17 deletions README-ZH.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# biyi

[![GitHub (pre-)release](https://img.shields.io/github/release/biyidev/biyi/all.svg?style=flat-square)](https://github.com/biyidev/biyi/releases) [![GitHub (pre-)release](https://img.shields.io/badge/distribute%20with-flutter__distributor-green?style=flat-square)](https://github.com/leanflutter/flutter_distributor)
[![GitHub (pre-)release](https://img.shields.io/github/release/lijy91/biyi/all.svg?style=flat-square)](https://github.com/lijy91/biyi/releases) [![GitHub (pre-)release](https://img.shields.io/badge/distribute%20with-flutter__distributor-green?style=flat-square)](https://github.com/leanflutter/flutter_distributor)

**比译** 是一个用 Flutter 编写的便捷翻译和词典应用。[查看文档](https://biyidev.com/docs/)

Expand All @@ -18,24 +18,24 @@

| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
| ✔️ | ✔️ | ✔️ |

## 安装

下载可以在[发布版本](https://github.com/biyidev/biyi/releases/latest)页面上找到,也可以在[网站](https://biyidev.com/release-notes)上找到其他安装方法。
下载可以在[发布版本](https://github.com/lijy91/biyi/releases/latest)页面上找到,也可以在[网站](https://biyidev.com/release-notes)上找到其他安装方法。

**要用 Homebrew 安装,请运行:**

```bash
brew tap biyidev/biyi
brew tap lijy91/biyi
brew install biyi
```

## 开发

我们欢迎您加入比译的开发。

> 在提出 Pull Request 之前,请务必阅读[贡献指南](https://github.com/biyidev/biyi/blob/main/.github/CONTRIBUTING.md)
> 在提出 Pull Request 之前,请务必阅读[贡献指南](https://github.com/lijy91/biyi/blob/main/.github/CONTRIBUTING.md)
### ⚠️ Linux requirements

Expand All @@ -51,23 +51,16 @@ sudo apt-get install keybinder-3.0

### 开始之前

1. 创建工作目录
1. 通过 git 克隆代码库:

```
$ mkdir ~/biyidev
$ cd ~/biyidev
$ git clone https://github.com/lijy91/biyi.git
```

2. 通过 git 克隆代码库:
2. 切换到 `biyi` 目录

```
$ git clone https://github.com/biyidev/biyi.git
```

3. 切换到 `biyi` 目录

```
$ cd ~/biyidev/biyi
$ cd ~/biyi
```

4. 安装依赖项
Expand All @@ -91,7 +84,7 @@ $ flutter run -d linux / macos / windows

## Related Links

- https://github.com/biyidev/biyi
- https://github.com/lijy91/biyi
- https://github.com/biyidev/uni_ocr
- https://github.com/biyidev/uni_translate
- https://github.com/leanflutter/hotkey_manager
Expand Down
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# biyi

[![GitHub (pre-)release](https://img.shields.io/github/release/biyidev/biyi/all.svg?style=flat-square)](https://github.com/biyidev/biyi/releases) [![GitHub (pre-)release](https://img.shields.io/badge/distribute%20with-flutter__distributor-green?style=flat-square)](https://github.com/leanflutter/flutter_distributor)
[![GitHub (pre-)release](https://img.shields.io/github/release/lijy91/biyi/all.svg?style=flat-square)](https://github.com/lijy91/biyi/releases) [![GitHub (pre-)release](https://img.shields.io/badge/distribute%20with-flutter__distributor-green?style=flat-square)](https://github.com/leanflutter/flutter_distributor)

**Biyi** is a convenient translation and dictionary app written in `Flutter`. [View document](https://biyidev.com/docs/)

Expand All @@ -18,24 +18,24 @@ English | [简体中文](./README-ZH.md)

| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
| ✔️ | ✔️ | ✔️ |

## Installation

Downloads are available on the [Releases](https://github.com/biyidev/biyi/releases/latest) page. Also check out the [website](https://biyidev.com/release-notes) for other installation methods.
Downloads are available on the [Releases](https://github.com/lijy91/biyi/releases/latest) page. Also check out the [website](https://biyidev.com/release-notes) for other installation methods.

**To install with Homebrew, run:**

```bash
brew tap biyidev/biyi
brew tap lijy91/biyi
brew install biyi
```

## Development

We welcome you to join the development of `Biyi`.

> Please make sure to read the [Contributing Guide](https://github.com/biyidev/biyi/blob/main/.github/CONTRIBUTING.md) before making a pull request.
> Please make sure to read the [Contributing Guide](https://github.com/lijy91/biyi/blob/main/.github/CONTRIBUTING.md) before making a pull request.
### ⚠️ Linux requirements

Expand All @@ -51,26 +51,19 @@ sudo apt-get install keybinder-3.0

### Before You Start

1. Create working directory
1. Clone this repo via git:

```
$ mkdir ~/biyidev
$ cd ~/biyidev
$ git clone https://github.com/lijy91/biyi.git
```

2. Clone this repo via git:
2. Change to `biyi` directory

```
$ git clone https://github.com/biyidev/biyi.git
$ cd ~/lijy91/biyi
```

3. Change to `biyi` directory

```
$ cd ~/biyidev/biyi
```

4. Install dependencies
3. Install dependencies

```
$ melos bs
Expand All @@ -91,7 +84,7 @@ $ flutter run -d linux / macos / windows

## Related Links

- https://github.com/biyidev/biyi
- https://github.com/lijy91/biyi
- https://github.com/biyidev/uni_ocr
- https://github.com/biyidev/uni_translate
- https://github.com/leanflutter/hotkey_manager
Expand Down
2 changes: 1 addition & 1 deletion apps/biyi_app/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: biyi_app
description: A convenient translation and dictionary app written in Flutter.
homepage: https://github.com/biyidev/biyi
homepage: https://github.com/lijy91/biyi
publish_to: "none"
version: 0.5.0+20

Expand Down
2 changes: 1 addition & 1 deletion integrations/popclip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Translate the text using `Biyi`.

## Installation

Download the file from [Releases](https://github.com/biyidev/biyi/releases) and double click to install the extension.
Download the file from [Releases](https://github.com/lijy91/biyi/releases) and double click to install the extension.
2 changes: 1 addition & 1 deletion melos.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: biyi_workspace
repository: https://github.com/biyidev/biyi
repository: https://github.com/lijy91/biyi

packages:
- apps/*
Expand Down

0 comments on commit 9935223

Please sign in to comment.