Files
mirakurun-rs/README.md
2026-07-31 16:43:42 +09:00

48 lines
2.0 KiB
Markdown

# mirakurun-rs
Mirakurun 4.1.3の実行時置換を目指す、Linux向けRust実装です。単一の
`mirakurun-rs` バイナリにHTTP/WebSocketサーバーとビルド済みReact UIを内包し、
本番実行時にNode.jsを必要としません。
現在は移行作業中です。チューナー共有、MPEG-TSサービス抽出、外部デコーダー、
EIT/SDTの基本解析、EPG・サービス更新ジョブ、チャンネルスキャン、REST API、
JSON-RPC、設定・DB、Web UIを実装しています。ただしARIB外字と一部記述子、
実機・差分・長時間試験は未完了です。本番切り替え前に
[`development_status.md`](../Mirakurun/development_status.md) の制約を確認してください。
## ビルドと検証
```console
cd web
npm ci
npm run typecheck
npm run build
cd ..
cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace --all-features
cargo build --release --locked -p mirakurun-rs
```
サーバーはサブコマンドなし、または `serve` で起動します。
```console
cargo run -p mirakurun-rs -- --help
cargo run -p mirakurun-rs -- serve
```
ネイティブ導入手順は [doc/installation.md](doc/installation.md)、Node.js版からの
移行手順は [doc/migration.md](doc/migration.md) を参照してください。Dockerは
オプション扱いで、ネイティブ版の互換性完成後に追加します。
## 著作権 / ライセンス
Copyright 2016- [kanreisa](https://github.com/kanreisa).
- コード: [Apache License, Version 2.0](LICENSE)
- ドキュメント: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
- ロゴ: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
Rust版はMirakurunを基準に移植した派生実装です。依存ライブラリには各ライブラリの
ライセンスが適用されます。バイナリを再配布する場合は`LICENSE`も同梱してください。