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.

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

Jump to bottom

Update the installation steps of the README #269

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −0
Open

Update the installation steps of the README #269

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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@ PropEr is also tightly integrated with Erlang's type language:
Quickstart guide
----------------

### Using PropEr as a dependency for your project

* Add PropEr to the list of dependencies of your project. This is done differently
depending on whether you are adding it to an Erlang or an Elixir project.
* In Erlang, you have to add it in `rebar.config`:

```erlang
{deps, [{proper, "1.3.0"}]}.
```

* In Elixir, you have to add it in `mix.exs`:

```elixir
def deps do
[{:proper, "~> 1.3"}]
end
```

### Installing PropEr locally and adding it to the path

* Obtain a copy of PropEr's sources. You can either get a tagged version of
the tool (look under `Tags` on github) or you can clone the current code
base:
Expand All @@ -103,6 +123,8 @@ Quickstart guide
brew install proper
```
and continue following the instructions below.
> The path that you will need, in most cases, if you used `brew` is
> `/usr/local/Cellar/proper/1.3`
Comment on lines +126 to +127
Copy link

Choose a reason for hiding this comment

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

Please don't recommend users rely on Cellar paths -- these are fragile and could be changed at any moment (i.e. even if proper's version does not change). Instead, users should use what's recommended in brew info proper:

==> Caveats
To use PropEr in Erlang, you may need:
  export ERL_LIBS=/opt/homebrew/opt/proper/proper-1.4

* Add PropEr's base directory to your Erlang library path, using one of the
following methods:
1. `ERL_LIBS` environment variable: Add the following line to your shell
Expand Down