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

doc: explain OpenSSL configuration for development #18

Merged
merged 1 commit into from
Aug 1, 2024
Merged
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ children = [

Full documentation is available on [HexDocs](https://hexdocs.pm/server_sent_event_stage/).

## Development

This project is developed against a version of Erlang that has trouble finding
OpenSSL on some systems. You may see `* ssl : No usable OpenSSL found` in the
Erlang compile output, and `mix deps.get` will subsequently fail due to missing
SSL support. To fix this, compile Erlang using the `--with-ssl=<PATH>` option.
For example, on macOS using OpenSSL installed through Homebrew:

KERL_CONFIGURE_OPTIONS="--with-ssl=$(brew --prefix openssl)" asdf install

## License

`server_sent_event_stage` is licensed under the [MIT](LICENSE) license.
Loading