Skip to content

docs: Add detailed uv installation guide in README files#148

Merged
tptpp merged 9 commits intomainfrom
docs/add-uv-installation
Mar 9, 2026
Merged

docs: Add detailed uv installation guide in README files#148
tptpp merged 9 commits intomainfrom
docs/add-uv-installation

Conversation

@csunny
Copy link
Contributor

@csunny csunny commented Mar 9, 2026

Summary

  • Add comprehensive uv installation instructions for macOS/Linux and Windows platforms
  • Provide complete dependency installation steps with all required extras using uv sync
  • Update English, Chinese, and Japanese README versions for consistency
  • Improve developer onboarding experience with clearer setup instructions

Changes

  • Added uv installation guide with platform-specific commands
  • Replaced sh scripts/prepare_release.sh with explicit uv sync command showing all required extras
  • Ensured consistency across all language versions of the main README

Test Plan

  • Verified all README files are updated consistently
  • Confirmed uv installation commands are correct for both macOS/Linux and Windows
  • Checked that all required extras are included in the uv sync command

This change makes it easier for developers to set up the development environment from source.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 9, 2026
@tptpp tptpp merged commit ab77ccc into main Mar 9, 2026
1 check passed
Copy link
Collaborator

@yhjun1026 yhjun1026 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants