Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 レシピ、ライブラリガイドを収録しています。

Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down