Skip to content

Commit

Permalink
Readmeの修正
Browse files Browse the repository at this point in the history
  • Loading branch information
kazuki0824 committed Nov 5, 2023
1 parent b42a7d3 commit 525fd1f
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Rust で書かれたテレビチューナーリーダー / ARIB STD-B25 デコ
Tools for reading ARIB STD-B25, and dealing with some kinds of tuner devices. Works fine on both Windows and Linux.
recisdb-rs and b25-sys are more convenient Rust wrapper for libaribb25. recisdb can read both Unix character device-based and BonDriver-based TV sources.

---

## Features

- クロスプラットフォーム (BonDriver / キャラクタデバイス (chardev) / DVBv5 デバイスすべてに対応)
Expand Down Expand Up @@ -40,23 +42,9 @@ wget https://github.com/kazuki0824/recisdb-rs/releases/download/1.1.0/recisdb_1.
sudo apt install ./recisdb_1.1.0_arm64.deb
rm ./recisdb_1.1.0_arm64.deb
```

Windows では `recisdb.exe` をダウンロードし、適当なフォルダに配置してください。

```bash
git clone https://github.com/kazuki0824/recisdb-rs.git
cd recisdb-rs
sudo apt install -y build-essential clang cmake libdvbv5-dev libpcsclite-dev libudev-dev pkg-config
cargo build -F dvb --release
sudo cp -a target/release/recisdb /usr/local/bin
```

Rust をインストールしたら、上記のコマンドで recisdb をビルドできます。
ビルドした recisdb は、`target/release/recisdb` に生成されます。

> [!IMPORTANT]
> `cargo build` を実行する際 `-F dvb` を指定すると、libdvbv5 経由での DVB デバイスの操作がサポートされます。
> `-F dvb` を指定してビルドした場合、動作には別途 `libdvbv5-0` パッケージが必要です。
---

## Usage

Expand Down Expand Up @@ -178,6 +166,8 @@ recisdb.exe tune --device .\BonDriver_mirakc.dll -c 0-8 -t 20 recorded.m2ts
recisdb.exe decode -i %USERPROFILE%\Desktop\scrambled.m2ts .\descrambled.m2ts
```

---

## Build

recisdb をビルドするには Rust が必要です。
Expand All @@ -193,6 +183,24 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
上記のコマンドで Rustup をインストールできます。
Rustup をインストールするだけで、Rust とビルドに必要なツールチェインが同時にインストールされます。

```bash
git clone https://github.com/kazuki0824/recisdb-rs.git
cd recisdb-rs
sudo apt install -y build-essential clang cmake libdvbv5-dev libpcsclite-dev libudev-dev pkg-config
cargo build -F dvb --release
sudo cp -a target/release/recisdb /usr/local/bin
```

Rust をインストールしたら、上記のコマンドで recisdb をビルドできます。
ビルドした recisdb は、`target/release/recisdb` に生成されます。
`cargo install`などで、パスの通った場所へ実行ファイルを自動的に配置することができます。

> [!IMPORTANT]
> `cargo build` を実行する際 `-F dvb` を指定すると、libdvbv5 経由での DVB デバイスの操作がサポートされます。
> `-F dvb` を指定してビルドした場合、動作には別途 `libdvbv5-0` パッケージが必要です。
---

## Licence

[GPL v3](https://github.com/kazuki0824/recisdb-rs/blob/master/LICENSE)
Expand Down

0 comments on commit 525fd1f

Please sign in to comment.