diff --git a/README.ja.md b/README.ja.md index 9cc7d5aa..fc89fa51 100644 --- a/README.ja.md +++ b/README.ja.md @@ -32,6 +32,14 @@ - ライブラリバインディング — 同じエンジンを Rust クレート、 [Python パッケージ](https://pypi.org/project/big-code-analysis/)、REST サーバー(`bca-web`)として利用できます。 +インストール前に出力を確認したい場合は、`bca` が `main` へのプッシュのたびに +自分自身のソースを解析して公開している結果をご覧ください。 + +- [**HTML ホットスポットレポート(実例)**](https://dekobon.github.io/big-code-analysis/reports/index.html) + — ファイル単位・関数単位でブラウズできるビュー(英語)。 +- [**Markdown レポート(実例)**](https://dekobon.github.io/big-code-analysis/reports/report.md) + — 同じ実行結果をプルリクエストのコメント形式にしたもの(英語)。 + 完全なドキュメントは[**ドキュメントブック(日本語版)**](https://dekobon.github.io/big-code-analysis/ja/)にあります。 メトリクスの定義、コマンドリファレンス、CI レシピ、ライブラリガイドを収録しています。 diff --git a/README.md b/README.md index d28ad52f..f4c02ffb 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,15 @@ that grows the metric engine into a code-quality toolchain: [Python package](https://pypi.org/project/big-code-analysis/), and a REST server (`bca-web`). +`bca` analyses its own source on every push to `main` and publishes +the result, so you can see what a real run looks like before +installing anything: + +- [**Live HTML hotspot report**](https://dekobon.github.io/big-code-analysis/reports/index.html) + — the browsable per-file, per-function view. +- [**Live Markdown report**](https://dekobon.github.io/big-code-analysis/reports/report.md) + — the same run as a pull-request comment. + The full documentation lives in [**the book**](https://dekobon.github.io/big-code-analysis/): metrics definitions, command reference, CI recipes, and library guides.