Skip to content
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

feat: Add macOS support with installation script #2

Merged
merged 3 commits into from
Dec 28, 2024

Conversation

YoungPhlo
Copy link
Contributor

Relates to:

Resolves #1

Risks

Low - Changes are additive and don't modify existing functionality

  • Only affects macOS installation process
  • No changes to core application code

Background

What does this PR do?

  • Adds macOS installation support via install.sh script
  • Updates README with macOS-specific installation instructions
  • Adds .gitignore file to exclude embeddings cache and virtual environment

What kind of change is this?

Features (non-breaking change which adds functionality)

  • Adds macOS installation support while maintaining existing Windows functionality

Documentation changes needed?

Documentation has been updated in this PR:

  • Added macOS installation instructions to README.md
  • Added section specifically for Mac users with step-by-step guide

Testing

Where should a reviewer start?

  1. Review install.sh script
  2. Review updated README.md macOS instructions

Detailed testing steps

On a macOS system:

  1. Install Python 3.10 via homebrew
  2. Clone the repository
  3. Run chmod +x install.sh
  4. Execute ./install.sh
  5. Verify the application launches and opens in browser
  6. Test that the sample browser functions correctly

Deploy Notes

New files added:

  • install.sh - Installation script for macOS
  • .gitignore - Standard Python gitignore with custom additions

The install.sh script:

  • Creates a Python virtual environment
  • Installs required dependencies
  • Sets up PyTorch with MPS support for Apple Silicon
  • Creates and configures run.sh for easy launching

@YoungPhlo YoungPhlo changed the title feat: Add macOS support with installation script, closes #1 feat: Add macOS support with installation script Dec 24, 2024
@lyramakesmusic lyramakesmusic merged commit 03015b1 into lyramakesmusic:main Dec 28, 2024
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.

request: macOS installation instructions
2 participants