summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortanaka takashi <isazaka@gmail.com>2026-06-23 01:26:51 +0900
committertanaka takashi <isazaka@gmail.com>2026-06-23 01:26:51 +0900
commitde0513e7cb0593b1aa141e367ff4da7156d6110f (patch)
treed8ac1c8746d2c9a51007c66349a50679392c36f9 /README.md
First Commit.
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..261007b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# ollama-web
+
+Ollama を用いた Web アプリケーションプロジェクト。
+
+## セットアップ
+
+```bash
+# 仮想環境の作成
+uv venv .venv
+
+# 依存パッケージのインストール
+uv pip install -r requirements.txt -p .venv
+
+# 開発用パッケージのインストール
+uv pip install -e ".[dev]" -p .venv
+```
+
+## プロジェクト構成
+
+```
+ollama-web/
+├── src/
+│ └── ollama_web/ # メインパッケージ
+│ ├── __init__.py
+│ └── main.py # エントリポイント
+├── tests/ # テストコード
+├── docs/ # ドキュメント
+├── scripts/ # スクリプト類
+├── .gitignore
+├── pyproject.toml # プロジェクト設定 (ruff, pytest, mypy 等)
+├── requirements.txt # 本番依存パッケージ
+└── README.md
+```
+
+## 使い方
+
+```bash
+# アプリケーションの実行
+ollama-web
+
+# テストの実行
+pytest
+
+# リント
+ruff check .
+
+# 型チェック
+mypy src/
+```
+
+## ライセンス
+
+MIT \ No newline at end of file