DeL-TaiseiOzaki commited on
Commit
3849a48
1 Parent(s): 227e75d

readme編集

Browse files
Files changed (2) hide show
  1. README copy.md +0 -96
  2. README.md +96 -12
README copy.md DELETED
@@ -1,96 +0,0 @@
1
- # get_repository_info_by_llm
2
-
3
- プログラミング関連ファイルを再帰的にスキャンし、内容を単一のテキストファイルにエクスポートするツールです。GitHubリポジトリまたはローカルディレクトリに対応しています。
4
-
5
- ## 機能
6
-
7
- - GitHubリポジトリのクローンとスキャン
8
- - ローカルディレクトリのスキャン
9
- - 再帰的なファイル検索
10
- - 主要なプログラミング言語ファイルの検出
11
- - UTF-8/CP932エンコーディングの自動検出
12
- - 結果のテキストファイル出力
13
-
14
- ## 必要条件
15
-
16
- - Python 3.7以上
17
- - Git(GitHubリポジトリをスキャンする場合)
18
-
19
- ## インストール
20
-
21
- 1. リポジトリをクローン
22
- ```bash
23
- git clone [このリポジトリのURL]
24
- cd directory-scanner
25
- ```
26
-
27
- 2. 必要なディレクトリを作成
28
- ```bash
29
- mkdir output
30
- ```
31
-
32
- ## 使用方法
33
-
34
- ### コマンドライン
35
- ```bash
36
- # GitHubリポジトリをスキャン
37
- python main.py https://github.com/username/repository.git
38
-
39
- # ローカルディレクトリをスキャン
40
- python main.py /path/to/directory
41
- ```
42
-
43
- ### シェルスクリプトを使用
44
- ```bash
45
- # スクリプトに実行権限を付与
46
- chmod +x scan.sh
47
-
48
- # GitHubリポジトリをスキャン
49
- ./scan.sh https://github.com/username/repository.git
50
-
51
- # ローカルディレクトリをスキャン
52
- ./scan.sh /path/to/directory
53
- ```
54
-
55
- ## 出力形式
56
-
57
- スキャン結果は `output` ディレクトリに保存され、以下の形式で出力されます:
58
-
59
- ```
60
- #ファイルパス
61
- path/to/file.py
62
- ------------
63
- ファイルの内容
64
- ```
65
-
66
- ## スキャン対象
67
-
68
- ### 対象となるファイル拡張子
69
- - Python (.py)
70
- - JavaScript (.js)
71
- - Java (.java)
72
- - C/C++ (.c, .h, .cpp, .hpp)
73
- - Go (.go)
74
- - Rust (.rs)
75
- - PHP (.php)
76
- - Ruby (.rb)
77
- - TypeScript (.ts)
78
- - その他 (.scala, .kt, .cs, .swift, .m, .sh, .pl, .r)
79
-
80
- ### 除外されるディレクトリ
81
- - .git
82
- - __pycache__
83
- - node_modules
84
- - venv
85
- - .env
86
- - build
87
- - dist
88
- - target
89
- - bin
90
- - obj
91
-
92
- ## 注意事項
93
-
94
- - GitHubリポジトリをスキャンする場合、一時的にローカルにクローンされます
95
- - スキャン完了後、クローンされたリポジトリは自動的に削除されます
96
- - 大きなファイルや特殊なエンコーディングのファイルは読み取れない場合があります
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -1,12 +1,96 @@
1
- ---
2
- title: Repository Reader
3
- emoji: 🔥
4
- colorFrom: pink
5
- colorTo: gray
6
- sdk: streamlit
7
- sdk_version: 1.39.0
8
- app_file: app.py
9
- pinned: false
10
- ---
11
-
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # get_repository_info_by_llm
2
+
3
+ プログラミング関連ファイルを再帰的にスキャンし、内容を単一のテキストファイルにエクスポートするツールです。GitHubリポジトリまたはローカルディレクトリに対応しています。
4
+
5
+ ## 機能
6
+
7
+ - GitHubリポジトリのクローンとスキャン
8
+ - ローカルディレクトリのスキャン
9
+ - 再帰的なファイル検索
10
+ - 主要なプログラミング言語ファイルの検出
11
+ - UTF-8/CP932エンコーディングの自動検出
12
+ - 結果のテキストファイル出力
13
+
14
+ ## 必要条件
15
+
16
+ - Python 3.7以上
17
+ - Git(GitHubリポジトリをスキャンする場合)
18
+
19
+ ## インストール
20
+
21
+ 1. リポジトリをクローン
22
+ ```bash
23
+ git clone [このリポジトリのURL]
24
+ cd directory-scanner
25
+ ```
26
+
27
+ 2. 必要なディレクトリを作成
28
+ ```bash
29
+ mkdir output
30
+ ```
31
+
32
+ ## 使用方法
33
+
34
+ ### コマンドライン
35
+ ```bash
36
+ # GitHubリポジトリをスキャン
37
+ python main.py https://github.com/username/repository.git
38
+
39
+ # ローカルディレクトリをスキャン
40
+ python main.py /path/to/directory
41
+ ```
42
+
43
+ ### シェルスクリプトを使用
44
+ ```bash
45
+ # スクリプトに実行権限を付与
46
+ chmod +x scan.sh
47
+
48
+ # GitHubリポジトリをスキャン
49
+ ./scan.sh https://github.com/username/repository.git
50
+
51
+ # ローカルディレクトリをスキャン
52
+ ./scan.sh /path/to/directory
53
+ ```
54
+
55
+ ## 出力形式
56
+
57
+ スキャン結果は `output` ディレクトリに保存され、以下の形式で出力されます:
58
+
59
+ ```
60
+ #ファイルパス
61
+ path/to/file.py
62
+ ------------
63
+ ファイルの内容
64
+ ```
65
+
66
+ ## スキャン対象
67
+
68
+ ### 対象となるファイル拡張子
69
+ - Python (.py)
70
+ - JavaScript (.js)
71
+ - Java (.java)
72
+ - C/C++ (.c, .h, .cpp, .hpp)
73
+ - Go (.go)
74
+ - Rust (.rs)
75
+ - PHP (.php)
76
+ - Ruby (.rb)
77
+ - TypeScript (.ts)
78
+ - その他 (.scala, .kt, .cs, .swift, .m, .sh, .pl, .r)
79
+
80
+ ### 除外されるディレクトリ
81
+ - .git
82
+ - __pycache__
83
+ - node_modules
84
+ - venv
85
+ - .env
86
+ - build
87
+ - dist
88
+ - target
89
+ - bin
90
+ - obj
91
+
92
+ ## 注意事項
93
+
94
+ - GitHubリポジトリをスキャンする場合、一時的にローカルにクローンされます
95
+ - スキャン完了後、クローンされたリポジトリは自動的に削除されます
96
+ - 大きなファイルや特殊なエンコーディングのファイルは読み取れない場合があります