Skip to content

README のインストール手順を実運用に合わせて更新(Release配布whl / Python 3.11+ / 開発用セットアップ) #1

@ShinoharaTa

Description

@ShinoharaTa

現在の README だと、配布 whl の入手先や前提条件が十分に明示されておらず、初回セットアップ時に詰まりやすいです。
以下を README に追記・整理したいです。

  • 配布 whl は GitHub Releases ページ(Assets)から取得すること
  • uag の前提が Python 3.11+ であること
  • venv 作成 -> pip 更新 -> ./uag--py3-none-any.whl インストールの手順
  • リポジトリ開発時は pip install -e .(Web利用時は pip install -e ".[web]")を推奨すること

背景

  • pip install uag-...whl だけだと、環境によって前提不足で失敗しやすい
  • ユーザーが Release 配布物を見つけにくい

完了条件

  • README 単体で、配布版利用者と開発者のどちらも迷わずセットアップできる状態になっていること

※Codex によるサポート

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions