Skip to content

Commit 25ed787

Browse files
myoshi2891myoshi2891
authored
Merge pull request #276 from myoshi2891/dev-from-macmini
docs: add repository description and update readme
2 parents 3ff7820 + 2a9f2d7 commit 25ed787

2 files changed

Lines changed: 58 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 56 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -228,11 +228,11 @@ graph LR
228228

229229
### ドキュメント階層技術仕様
230230

231-
| 階層 | ファイル | 対象 | 技術スタック | 主要機能 | ファイルサイズ |
232-
| ------------------ | ----------------- | ------------------------ | ------------------------------ | ----------------------------------------------------------------------------------- | ------------------- |
233-
| **1. Static** | README.md | CS学習者、初心者 | 純粋なMarkdown、依存関係なし | 問題概要、アルゴリズム説明、複雑度分析O(n)、実装詳細、最適化議論 | ~1KB、200-400行 |
234-
| **2. Interactive** | README.html | 競技プログラマー | Prism.js、Tailwind CSS | 構文ハイライト、Play/Pause/Stepコントロール、状態可視化、SVGフローチャート描画 | ~50KB、1000-2000行 |
235-
| **3. Dynamic** | README_react.html | パフォーマンスエンジニア | React 18 UMD、Babel Standalone | React Hooks (useState, useEffect)、リアルタイム入力操作、アルゴリズム再実行、AI比較 | ~100KB、2000-4000行 |
231+
| 階層 | ファイル | 対象 | 技術スタック | 主要機能 | ファイルサイズ |
232+
| ------------------ | ----------------- | ------------------------ | ---------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------- |
233+
| **1. Static** | README.md | CS学習者、初心者 | 純粋なMarkdown、依存関係なし | 問題概要、アルゴリズム説明、複雑度分析O(n)、実装詳細、最適化議論 | ~1KB、200-400行 |
234+
| **2. Interactive** | README.html | 競技プログラマー | Prism.js、Tailwind CSS | 構文ハイライト、Play/Pause/Stepコントロール、状態可視化、SVGフローチャート描画 | ~50KB、1000-2000行 |
235+
| **3. Dynamic** | README_react.html | パフォーマンスエンジニア | React 18 UMD (Local), Babel Standalone (Local) | React Hooks (useState, useEffect)、リアルタイム入力操作、アルゴリズム再実行、AI比較 | ~100KB、2000-4000行 |
236236

237237
### 静的ドキュメント構造(階層1)
238238

@@ -291,7 +291,7 @@ graph TB
291291
end
292292
293293
subgraph "ドキュメントレイヤー"
294-
D1[CDN経由の外部ライブラリ]
294+
D1[ローカル管理された外部ライブラリ (Vendor)]
295295
D2[Prism.js, Tailwind, React]
296296
D3[README.html, README_react.html]
297297
end
@@ -375,14 +375,14 @@ def daily_active_users(activity: pd.DataFrame) -> pd.DataFrame:
375375

376376
### ファイルタイプ仕様
377377

378-
| ファイルタイプ | 命名パターン | コード構造 | ファイルサイズ | パス例 |
379-
| -------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
380-
| **Python実装** | `{ProblemName}.py` (Claude)<br>`{ProblemName}_py.ipynb` (GPT) | `class Solution:`<br>`def {methodName}(self, ...) -> ...:`<br>ヘルパーメソッドを含む場合あり | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.py` |
381-
| **TypeScript実装** | `{ProblemName}.ts` (Claude)<br>`{ProblemName}_ts.ipynb` (GPT) | `function {functionName}(...): ReturnType { ... }`<br>または<br>`class Solution { {methodName}(...): ReturnType { ... } }` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/gpt 5.1 thinking customized/Interleaving_String_ts.ipynb` |
382-
| **JavaScript実装** | `{ProblemName}.js` (Claude)<br>`{ProblemName}_js.ipynb` (GPT) | `var {functionName} = function(...) { ... };`<br>`module.exports = { {functionName} };` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.js` |
383-
| **静的ドキュメント** | `README.md` | 5セクションMarkdown:<br>1. Overview (`<h2 id="overview">`)<br>2. Algorithm (`<h2 id="tldr">`)<br>3. Complexity (`<h2 id="complexity">`)<br>4. Implementation (`<h2 id="impl">`)<br>5. Optimization (`<h2 id="cpython">`) | 3000-5000語<br>(~200-400行) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.md` |
384-
| **対話型HTML** | `README.html` | 埋め込みJavaScriptを含むHTML:<br>`<script src="...prism.js"></script>`<br>`<script src="...tailwindcss.com"></script>`<br>ボタン付きステップコントロールシステム | 1000-2000行<br>(~50KB) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.html` |
385-
| **React可視化** | `README_react.html` | React CDNを含むHTML:<br>`<script src="...react.development.js"></script>`<br>`<script src="...babel.standalone.js"></script>`<br>`<script type="text/babel">`内のJSXコンポーネント | 2000-4000行<br>(~100KB) | `Algorithm/BinarySearch/leetcode/99. Recover Binary Search Tree/Claude Opus 4.5/README_react.html` |
378+
| ファイルタイプ | 命名パターン | コード構造 | ファイルサイズ | パス例 |
379+
| -------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
380+
| **Python実装** | `{ProblemName}.py` (Claude)<br>`{ProblemName}_py.ipynb` (GPT) | `class Solution:`<br>`def {methodName}(self, ...) -> ...:`<br>ヘルパーメソッドを含む場合あり | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.py` |
381+
| **TypeScript実装** | `{ProblemName}.ts` (Claude)<br>`{ProblemName}_ts.ipynb` (GPT) | `function {functionName}(...): ReturnType { ... }`<br>または<br>`class Solution { {methodName}(...): ReturnType { ... } }` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/gpt 5.1 thinking customized/Interleaving_String_ts.ipynb` |
382+
| **JavaScript実装** | `{ProblemName}.js` (Claude)<br>`{ProblemName}_js.ipynb` (GPT) | `var {functionName} = function(...) { ... };`<br>`module.exports = { {functionName} };` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.js` |
383+
| **静的ドキュメント** | `README.md` | 5セクションMarkdown:<br>1. Overview (`<h2 id="overview">`)<br>2. Algorithm (`<h2 id="tldr">`)<br>3. Complexity (`<h2 id="complexity">`)<br>4. Implementation (`<h2 id="impl">`)<br>5. Optimization (`<h2 id="cpython">`) | 3000-5000語<br>(~200-400行) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.md` |
384+
| **対話型HTML** | `README.html` | ローカルベンダー管理のスクリプトを読み込むHTML:<br>`<script src="/vendor/prismjs/prism.js"></script>`<br>`<script src="/vendor/tailwindcss/script.js"></script>`<br>ボタン付きステップコントロールシステム | 1000-2000行<br>(~50KB) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.html` |
385+
| **React可視化** | `README_react.html` | ローカルベンダー管理のスクリプトを読み込むHTML:<br>`<script src="/vendor/react/react.development.js"></script>`<br>`<script src="/vendor/babel/babel.min.js"></script>`<br>`<script type="text/babel">`内のJSXコンポーネント | 2000-4000行<br>(~100KB) | `Algorithm/BinarySearch/leetcode/99. Recover Binary Search Tree/Claude Opus 4.5/README_react.html` |
386386

387387
### コード構造ブリッジ: クラスと関数パターン
388388

@@ -545,6 +545,48 @@ graph TD
545545

546546
---
547547

548+
## 開発セットアップ
549+
550+
このプロジェクトは、依存関係管理に`bun`を使用し、成果物生成にPythonを使用します。
551+
552+
### 前提条件
553+
554+
- [Bun](https://bun.sh) (v1.0.0+)
555+
- Python 3.11+
556+
557+
### セットアップ手順
558+
559+
1. **リポジトリのクローン**:
560+
561+
```bash
562+
git clone https://github.com/myoshi2891/Algorithm-DataStructures-Math-SQL.git
563+
cd Algorithm-DataStructures-Math-SQL
564+
```
565+
566+
2. **依存関係のインストール**:
567+
568+
```bash
569+
bun install
570+
```
571+
572+
3. **インデックスと成果物のビルド**:
573+
574+
```bash
575+
./update_index.sh
576+
```
577+
578+
これにより、`public/`ディレクトリが生成され、必要なベンダーファイルがコピーされます。
579+
580+
4. **ローカルサーバーの起動**:
581+
582+
```bash
583+
bun run serve
584+
```
585+
586+
ブラウザで `http://127.0.0.1:8080` を開いて確認します。
587+
588+
---
589+
548590
## インデックスメンテナンス
549591

550592
リポジトリのドキュメントインデックス(`public/index.html`)は自動生成されます。開発者は、新しい問題を追加した後にインデックスを最新の状態に保つために、Gitプレコミットフックを設定することが推奨されます。

‎package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
{
22
"name": "algorithm-study",
3+
"description": "A deterministic multi-language algorithm study repository (Python/TS/JS) with auto-generated documentation and local dependency management.",
34
"version": "1.0.0",
45
"type": "module",
56
"scripts": {
67
"dev": "tsx Algorithm/ts/main.ts",
8+
"serve": "live-server public",
79
"test": "vitest run",
810
"lint": "prettier -c . && eslint .",
911
"fmt": "prettier -w ."

0 commit comments

Comments
 (0)