MakiAi commited on
Commit
60f4497
·
1 Parent(s): a844b94

[docs] README.mdの全面的なリフォーマットと内容の更新

Browse files

プロジェクトのREADME.mdファイルに大幅な更新を施しました。具体的な変更内容は以下の通りです:

### ヘッダーの言語統一とタイトル変更
- ヘッダーセクションの言語を日本語に統一しました。
- セクションタイトルを「イントロダクション」から「Introduction」に変更し、より国際的なアプローチを取り入れました。

### コンテンツの構造調整
- 各セクションの見出しを変更し、文書の流れを改善しました(例:「デモ」を「Demo」に、「はじめに」を「Getting Started」に変更)。
- インストール手順と使用方法の説明にステップリストを追加し、より詳細かつ明確な指示を提供しました。

### ナビゲーションと可読性の向上
- 重要な情報を強調するために、インポータントボックスを導入しました。
- コマンドラインのコードブロックに改行を追加し、可読性を向上させました。

### その他の更新
- 「アップデート」セクションを「Changelog」に改名し、プロジェクトの変更履歴をより明確に示しました。
- 「コントリビューション」セクションを「Contributing」に変更し、貢献方法を国際的な視点で再構成しました。
- 「謝辞」セクションを「Acknowledgements」に改名し、支援者への感謝の意を表現しました。

この変更により、READMEファイルはよりプロフェッショナルでアクセスしやすいものとなり、国際的なユーザーにも理解しやすくなりました。

Files changed (1) hide show
  1. README.md +33 -22
README.md CHANGED
@@ -32,68 +32,79 @@ pinned: false
32
  >[!IMPORTANT]
33
  >このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) + [claude.ai](https://claude.ai/)で生成しています。
34
 
35
- ## 🌟 イントロダクション
36
 
37
- KotobaTranscriberは、日本語音声をテキストに変換するための最先端のソリューションです。最新の機械学習モデルを活用し、高精度な文字起こしを実現します。
38
 
39
- 音声ファイルをアップロードするだけで、KotobaTranscriberが自動的に音声を認識し、テキストに変換します。ビジネスミーティングや講義、インタビューなど、あらゆるシーンで活躍します。
40
 
41
- ## 🎥 デモ
42
 
43
- KotobaTranscriberのデモアプリケーションをHugging Face Spacesで公開しています。ぜひ、実際に体験してみてください。
44
 
45
  [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Sunwood-ai-labs/KotobaTranscriber)
46
 
47
- ## 🚀 はじめに
48
 
49
  ### インストール
50
 
51
- KotobaTranscriberのインストール手順は以下の通りです:
52
 
53
- 1. リポジトリをクローンします: `git clone https://github.com/Sunwood-ai-labs/KotobaTranscriber.git`
54
- 2. 必要な依存関係をインストールします: `pip install -r requirements.txt`
 
 
 
55
 
56
  ### 使用方法
57
 
58
- KotobaTranscriberの基本的な使用方法は以下の通りです:
 
 
 
59
 
60
- 1. `app.py`を実行します: `python app.py`
61
  2. ブラウザで`http://localhost:7860`にアクセスします
 
62
  3. 音声ファイルをアップロードします
 
63
  4. 文字起こし結果が表示されます
64
 
65
  詳細な使用方法については、[ドキュメント](https://github.com/Sunwood-ai-labs/KotobaTranscriber/wiki)をご参照ください。
66
 
 
 
 
67
 
68
  ```bash
69
  docker-compose up
70
  ```
71
 
72
- ## 📝 アップデート
73
 
74
  - v1.1.0 (2024-04-24):
75
  - フロントページの作成
76
- - READMEの全体的な改善
77
- - GitHub Actionsを使用したHuggingFace hubへの自動シンク機能の追加
78
- - .gitignoreと.gitattributesの更新
79
  - プロジェクト名を「HarmonAI」から「KotobaTranscriber」に変更
 
80
  - v1.0.0 (2024-04-20):
81
  - 初回リリース
82
  - 基本的な文字起こし機能を実装
83
 
84
- ## 🤝 コントリビューション
85
 
86
- KotobaTranscriberへのご協力は大歓迎です!バグ報告、機能要求、プルリクエストなどを通じて、プロジェクトの改善にご協力ください。詳細は[CONTRIBUTING.md](CONTRIBUTING.md)をご覧ください。
87
 
88
- ## 📄 ライセンス
89
 
90
- KotobaTranscriberは[MIT License](LICENSE)の下でリリースされています。
91
 
92
- ## 🙏 謝辞
93
 
94
- KotobaTranscriberの開発にあたり、以下の方々に感謝いたします:
95
 
96
  - [Sunwood-ai-labs](https://github.com/Sunwood-ai-labs)チームのメンバー
97
  - [kotoba-tech/kotoba-whisper-v1.0](https://huggingface.co/kotoba-tech/kotoba-whisper-v1.0)モデルの開発者の方々
98
 
99
- 引き続き、KotobaTranscriberプロジェクトをよろしくお願��いたします!
 
32
  >[!IMPORTANT]
33
  >このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) + [claude.ai](https://claude.ai/)で生成しています。
34
 
35
+ ## Introduction
36
 
37
+ KotobaTranscriber は、日本語音声をテキストに変換するための最先端のソリューションです。最新の機械学習モデルを活用し、高精度な文字起こしを実現します。
38
 
39
+ 音声ファイルをアップロードするだけで、KotobaTranscriber が自動的に音声を認識し、テキストに変換します。ビジネスミーティングや講義、インタビューなど、あらゆるシーンで活躍します。
40
 
41
+ ## Demo
42
 
43
+ KotobaTranscriber のデモアプリケーションを Hugging Face Spaces で公開しています。ぜひ、実際に体験してみてください。
44
 
45
  [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Sunwood-ai-labs/KotobaTranscriber)
46
 
47
+ ## Getting Started
48
 
49
  ### インストール
50
 
51
+ KotobaTranscriber のインストール手順は以下の通りです:
52
 
53
+ 1. リポジトリをクローンします:
54
+ `git clone https://github.com/Sunwood-ai-labs/KotobaTranscriber.git`
55
+
56
+ 2. 必要な依存関係をインストールします:
57
+ `pip install -r requirements.txt`
58
 
59
  ### 使用方法
60
 
61
+ KotobaTranscriber の基本的な使用方法は以下の通りです:
62
+
63
+ 1. `app.py`を実行します:
64
+ `python app.py`
65
 
 
66
  2. ブラウザで`http://localhost:7860`にアクセスします
67
+
68
  3. 音声ファイルをアップロードします
69
+
70
  4. 文字起こし結果が表示されます
71
 
72
  詳細な使用方法については、[ドキュメント](https://github.com/Sunwood-ai-labs/KotobaTranscriber/wiki)をご参照ください。
73
 
74
+ ### Docker の起動方法
75
+
76
+ KotobaTranscriber を Docker で起動するには、以下のコマンドを実行します:
77
 
78
  ```bash
79
  docker-compose up
80
  ```
81
 
82
+ ## Changelog
83
 
84
  - v1.1.0 (2024-04-24):
85
  - フロントページの作成
86
+ - README の全体的な改善
87
+ - GitHub Actions を使用した HuggingFace hub への自動シンク機能の追加
88
+ - .gitignore と .gitattributes の更新
89
  - プロジェクト名を「HarmonAI」から「KotobaTranscriber」に変更
90
+
91
  - v1.0.0 (2024-04-20):
92
  - 初回リリース
93
  - 基本的な文字起こし機能を実装
94
 
95
+ ## Contributing
96
 
97
+ KotobaTranscriber へのご協力は大歓迎です!バグ報告、機能要求、プルリクエストなどを通じて、プロジェクトの改善にご協力ください。詳細は[CONTRIBUTING.md](CONTRIBUTING.md)をご覧ください。
98
 
99
+ ## License
100
 
101
+ KotobaTranscriber は[MIT License](LICENSE)の下でリリースされています。
102
 
103
+ ## Acknowledgements
104
 
105
+ KotobaTranscriber の開発にあたり、以下の方々に感謝いたします:
106
 
107
  - [Sunwood-ai-labs](https://github.com/Sunwood-ai-labs)チームのメンバー
108
  - [kotoba-tech/kotoba-whisper-v1.0](https://huggingface.co/kotoba-tech/kotoba-whisper-v1.0)モデルの開発者の方々
109
 
110
+ 引き続き、KotobaTranscriber プロジェクトをよろしくお願いいたします!