Skip to content

Commit

Permalink
Update READMEs to remove references to mini-elp
Browse files Browse the repository at this point in the history
Summary: As title. Add instructions to use `build-info.json` in ELP's README

Reviewed By: alanz

Differential Revision: D53473206

fbshipit-source-id: ced608a35b515de553de0ce2259e20fc7932ecc3
  • Loading branch information
VLanvin authored and facebook-github-bot committed Feb 6, 2024
1 parent 5a6c332 commit d615b95
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A type-checker for Erlang.
## Using it with rebar3 projects

1. Use OTP 25
2. Download the `elp` binary for your system from https://github.com/WhatsApp/eqwalizer/releases
2. Download the `elp` binary for your system from https://github.com/WhatsApp/erlang-language-platform/releases

> On Mac you will probably get the following message when trying to run the executable the first time: "elp cannot be opened because the developer cannot be verified.".
To solve this, go to Preferences > Security and Privacy and add an exception. Alternatively, you can build elp from source.
Expand Down Expand Up @@ -46,7 +46,7 @@ Adding `eqwalizer_support` and `eqwalizer_rebar3`:
## Using it with non-rebar projects

1. Use OTP 25 (it will be detected automatically by eqWAlizer)
2. Download the `elp` binary for your system from https://github.com/WhatsApp/eqwalizer/releases
2. Download the `elp` binary for your system from https://github.com/WhatsApp/erlang-language-platform/releases
3. Write a `project.json` file describing your project, see below for the file structure.
Ensure `eqwalizer_support` is added as a dependency, and that its `ebin` folder is reachable and populated
with `.beam` files.
Expand All @@ -59,7 +59,6 @@ The `.json` file should be structured in this way:
{
"apps": [app list],
"deps": [app list], // 3rd party dependencies (not type-checked), defaults to []
"root": "path/to/root" // Defaults to ""
}
```
where an `app` is a map structured as such:
Expand All @@ -74,8 +73,6 @@ where an `app` is a map structured as such:
"macros": ["MACRO", ...], // Defaults to []
}
```
As an example, see the [build_info.json](https://github.com/WhatsApp/eqwalizer/blob/main/mini-elp/test_projects/standard/build_info.json)
file used to test mini-elp.


## FAQ
Expand Down

0 comments on commit d615b95

Please sign in to comment.