Skip to content

Update INSTALL.md with new tooling and instructions #2694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2025

Conversation

knguyen1
Copy link
Contributor

@knguyen1 knguyen1 commented Aug 1, 2025

Summary

  • This is a…
    • Bug fix
    • Feature addition
    • Refactoring
    • Minor / simple change (like a typo)
    • Other
  • Describe this change in 1-2 sentences: Updates INSTALL.md to reflect modern tooling changes from CONTRIBUTING.md, incorporating uv as an optional package manager and improving cross-platform installation instructions.

Problem

  • JIRA ticket (optional): PICARD-XXX

The INSTALL.md file was outdated and didn't reflect the modern development workflow using uv that was recently added to CONTRIBUTING.md. Users needed updated installation instructions that accommodate both traditional pip workflows and the new uv tooling.

Solution

  • Added platform-specific gettext installation instructions for Windows, Linux, and macOS
  • Introduced uv as an optional but recommended package manager alongside pip
  • Added dedicated "Installation using uv" section with proper virtual environment setup
  • Updated "Running From the Source Tree" section with both uv and pip approaches
  • Enhanced test running instructions with uv support
  • Added "Development Setup" section covering pre-commit hooks and code quality tools
  • Improved cross-platform support with proper activation commands for different OS
  • Maintained backward compatibility while introducing modern tooling options

Action

Additional actions required:

  • Update Picard documentation (please include a reference to this PR)
  • Other (please specify below)

Copy link
Collaborator

@zas zas left a comment

Choose a reason for hiding this comment

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

LGTM

@zas zas requested review from phw and rdswift August 1, 2025 15:06
Copy link
Collaborator

@rdswift rdswift left a comment

Choose a reason for hiding this comment

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

Looks good to me. I've never used uv or ruff before, and following the steps listed worked perfectly for me (tested on linux).

@zas zas merged commit b62e007 into metabrainz:master Aug 2, 2025
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants