[docs] READMEの更新
Browse files- CodeLumiaの概要と主な特徴を追加
- デモアプリのリンクを追加
- SourceSageとclaude.aiの活用について言及
- 前提条件としてDockerを追加
[chore] .gitattributesの更新
- *.gifファイルをGit LFSで管理するように設定
- .gitattributes +1 -0
- README.md +24 -0
.gitattributes
CHANGED
|
@@ -1 +1,2 @@
|
|
| 1 |
*.png filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 1 |
*.png filter=lfs diff=lfs merge=lfs -text
|
| 2 |
+
*.gif filter=lfs diff=lfs merge=lfs -text
|
README.md
CHANGED
|
@@ -27,6 +27,30 @@ license: mit
|
|
| 27 |
|
| 28 |
## 🚀 はじめに
|
| 29 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 30 |
### 前提条件
|
| 31 |
|
| 32 |
- Docker
|
|
|
|
| 27 |
|
| 28 |
## 🚀 はじめに
|
| 29 |
|
| 30 |
+
|
| 31 |
+
CodeLumiaへようこそ！CodeLumiaは、GitHubリポジトリのソースコードを分析し、包括的なマークダウン形式のドキュメントを自動生成するツールです。プロジェクトの構造、依存関係、設定などを簡単に理解できるようになります。
|
| 32 |
+
|
| 33 |
+
CodeLumiaは、開発者がコードベースをすばやく把握し、プロジェクトに効率的に貢献できるようにすることを目的としています。新しいチームメンバーのオンボーディングを容易にし、コードの保守性を向上させます。
|
| 34 |
+
|
| 35 |
+
>[!TIP]
|
| 36 |
+
>このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) ＋ [claude.ai](https://claude.ai/)で生成しています。
|
| 37 |
+
|
| 38 |
+
### 主な特徴:
|
| 39 |
+
|
| 40 |
+
- GitHubリポジトリの自動分析
|
| 41 |
+
- マークダウン形式のドキュメント生成
|
| 42 |
+
- ファイルとディレクトリの無視パターンのカスタマイズ
|
| 43 |
+
- わかりやすいStreamlitユーザーインターフェース
|
| 44 |
+
|
| 45 |
+
CodeLumiaを使用して、プロジェクトのドキュメンテーションを強化し、チームのコラボレーションを促進しましょう。ぜひお試しください！
|
| 46 |
+
|
| 47 |
+
|
| 48 |
+
## デモアプリ
|
| 49 |
+
|
| 50 |
+
[](https://huggingface.co/spaces/OFA-Sys/OFA-Image_Caption)
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
|
| 54 |
### 前提条件
|
| 55 |
|
| 56 |
- Docker
|