Skip to content

docs: add macOS dependency instructions to README #406

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.

Sign up for GitHub

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

Open
rearick wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add macOS dependency instructions to README #406

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,29 @@ Then, run `rake` to run RuboCop and the tests. While developing, you can
run `bin/gemstash` to run Gemstash. You can also run `bin/console` for
an interactive prompt that will allow you to experiment.

### macOS Dependencies

If you're developing on macOS, you may encounter issues with installing the PostgreSQL and MySQL native gems. To resolve these:

1. Install the required libraries via Homebrew:
```
brew install mysql libpq
```

2. Configure Bundler to use the correct paths for building the native extensions:
```
# For PostgreSQL
bundle config build.pg --with-pg-config=/usr/local/Cellar/libpq/[VERSION]/bin/pg_config
# Replace [VERSION] with your installed libpq version (e.g., 17.4_1)

# For MySQL
bundle config build.mysql2 --with-mysql-dir=/usr/local/opt/mysql
```

3. Run `bin/setup` again to complete the installation.

These configurations tell the Ruby gem system where to find the necessary headers and libraries needed to compile the native extensions for these gems.

## Contributing

Bug reports and pull requests are welcome on GitHub at
Expand Down