From be417c0757574e7674ba127bda7d0cdd4481de39 Mon Sep 17 00:00:00 2001 From: myoshizumi Date: Fri, 20 Feb 2026 01:17:02 +0900 Subject: [PATCH 1/2] docs: add repository description and update readme --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++------ package.json | 1 + 2 files changed, 49 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1f1f775f..c8d02c2c 100644 --- a/README.md +++ b/README.md @@ -228,11 +228,11 @@ graph LR ### ドキュメント階層技術仕様 -| 階層 | ファイル | 対象 | 技術スタック | 主要機能 | ファイルサイズ | -| ------------------ | ----------------- | ------------------------ | ------------------------------ | ----------------------------------------------------------------------------------- | ------------------- | -| **1. Static** | README.md | CS学習者、初心者 | 純粋なMarkdown、依存関係なし | 問題概要、アルゴリズム説明、複雑度分析O(n)、実装詳細、最適化議論 | ~1KB、200-400行 | -| **2. Interactive** | README.html | 競技プログラマー | Prism.js、Tailwind CSS | 構文ハイライト、Play/Pause/Stepコントロール、状態可視化、SVGフローチャート描画 | ~50KB、1000-2000行 | -| **3. Dynamic** | README_react.html | パフォーマンスエンジニア | React 18 UMD、Babel Standalone | React Hooks (useState, useEffect)、リアルタイム入力操作、アルゴリズム再実行、AI比較 | ~100KB、2000-4000行 | +| 階層 | ファイル | 対象 | 技術スタック | 主要機能 | ファイルサイズ | +| ------------------ | ----------------- | ------------------------ | ---------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------- | +| **1. Static** | README.md | CS学習者、初心者 | 純粋なMarkdown、依存関係なし | 問題概要、アルゴリズム説明、複雑度分析O(n)、実装詳細、最適化議論 | ~1KB、200-400行 | +| **2. Interactive** | README.html | 競技プログラマー | Prism.js、Tailwind CSS | 構文ハイライト、Play/Pause/Stepコントロール、状態可視化、SVGフローチャート描画 | ~50KB、1000-2000行 | +| **3. Dynamic** | README_react.html | パフォーマンスエンジニア | React 18 UMD (Local), Babel Standalone (Local) | React Hooks (useState, useEffect)、リアルタイム入力操作、アルゴリズム再実行、AI比較 | ~100KB、2000-4000行 | ### 静的ドキュメント構造(階層1) @@ -291,7 +291,7 @@ graph TB end subgraph "ドキュメントレイヤー" - D1[CDN経由の外部ライブラリ] + D1[ローカル管理された外部ライブラリ (Vendor)] D2[Prism.js, Tailwind, React] D3[README.html, README_react.html] end @@ -545,6 +545,48 @@ graph TD --- +## 開発セットアップ + +このプロジェクトは、依存関係管理に`bun`を使用し、成果物生成にPythonを使用します。 + +### 前提条件 + +- [Bun](https://bun.sh) (v1.0.0+) +- Python 3.11+ + +### セットアップ手順 + +1. **リポジトリのクローン**: + + ```bash + git clone https://github.com/myoshi2891/Algorithm-DataStructures-Math-SQL.git + cd Algorithm-DataStructures-Math-SQL + ``` + +2. **依存関係のインストール**: + + ```bash + bun install + ``` + +3. **インデックスと成果物のビルド**: + + ```bash + ./update_index.sh + ``` + + これにより、`public/`ディレクトリが生成され、必要なベンダーファイルがコピーされます。 + +4. **ローカルサーバーの起動**: + + ```bash + npx http-server public + ``` + + ブラウザで `http://127.0.0.1:8080` を開いて確認します。 + +--- + ## インデックスメンテナンス リポジトリのドキュメントインデックス(`public/index.html`)は自動生成されます。開発者は、新しい問題を追加した後にインデックスを最新の状態に保つために、Gitプレコミットフックを設定することが推奨されます。 diff --git a/package.json b/package.json index 0bd3bbc9..3c29ae64 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,6 @@ { "name": "algorithm-study", + "description": "A deterministic multi-language algorithm study repository (Python/TS/JS) with auto-generated documentation and local dependency management.", "version": "1.0.0", "type": "module", "scripts": { From 2a9f2d7030b017ba21af5729b54bb7487aa75f37 Mon Sep 17 00:00:00 2001 From: myoshizumi Date: Fri, 20 Feb 2026 01:28:27 +0900 Subject: [PATCH 2/2] docs: update readme and package.json based on review --- README.md | 18 +++++++++--------- package.json | 1 + 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c8d02c2c..cb7d8e5e 100644 --- a/README.md +++ b/README.md @@ -375,14 +375,14 @@ def daily_active_users(activity: pd.DataFrame) -> pd.DataFrame: ### ファイルタイプ仕様 -| ファイルタイプ | 命名パターン | コード構造 | ファイルサイズ | パス例 | -| -------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| **Python実装** | `{ProblemName}.py` (Claude)
`{ProblemName}_py.ipynb` (GPT) | `class Solution:`
`def {methodName}(self, ...) -> ...:`
ヘルパーメソッドを含む場合あり | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.py` | -| **TypeScript実装** | `{ProblemName}.ts` (Claude)
`{ProblemName}_ts.ipynb` (GPT) | `function {functionName}(...): ReturnType { ... }`
または
`class Solution { {methodName}(...): ReturnType { ... } }` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/gpt 5.1 thinking customized/Interleaving_String_ts.ipynb` | -| **JavaScript実装** | `{ProblemName}.js` (Claude)
`{ProblemName}_js.ipynb` (GPT) | `var {functionName} = function(...) { ... };`
`module.exports = { {functionName} };` | ~50-200行 | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/Interleaving_String.js` | -| **静的ドキュメント** | `README.md` | 5セクションMarkdown:
1. Overview (`

`)
2. Algorithm (`

`)
3. Complexity (`

`)
4. Implementation (`

`)
5. Optimization (`

`) | 3000-5000語
(~200-400行) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.md` | -| **対話型HTML** | `README.html` | 埋め込みJavaScriptを含むHTML:
``
``
ボタン付きステップコントロールシステム | 1000-2000行
(~50KB) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.html` | -| **React可視化** | `README_react.html` | React CDNを含むHTML:
``
``
``
``
ボタン付きステップコントロールシステム | 1000-2000行
(~50KB) | `Algorithm/DynamicProgramming/leetcode/97. Interleaving String/claude sonnet 4.5/README.html` | +| **React可視化** | `README_react.html` | ローカルベンダー管理のスクリプトを読み込むHTML:
``
``
`