Skip to content

Commit 5fe7e93

Browse files
robertoaloimeta-codesync[bot]
authored andcommitted
Update docs to take into account eqwalizer as a submodule
Summary: Simpler installation since the user does not have to clone a separate repository. Reviewed By: jcpetruzza, alanz Differential Revision: D85143542 fbshipit-source-id: 1302240a59c3c84b309cbfd2db00a52356160b10
1 parent 6d8c160 commit 5fe7e93

File tree

1 file changed

+9
-31
lines changed

1 file changed

+9
-31
lines changed

website/docs/get-started/install.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,14 @@ correctly installed.
5151

5252
## From Source
5353

54-
### Prerequisites
55-
56-
To be able to compile ELP from source, you need a copy of the
57-
[eqWAlizer](https://github.com/WhatsApp/eqwalizer) typechecker for Erlang.
58-
59-
Clone the eqWAlizer repository:
54+
Clone the ELP repository, including submodules:
6055

6156
```
62-
git clone https://github.com/WhatsApp/eqwalizer.git
57+
git clone --recurse-submodules https://github.com/WhatsApp/erlang-language-platform.git
58+
cd erlang-language-platform
6359
```
6460

65-
Enter the `eqwalizer` repository and build it. Notice the double `eqwalizer` in
61+
Enter the `eqwalizer` submodule and build it. Notice the double `eqwalizer` in
6662
the `pushd` command.
6763

6864
```
@@ -71,39 +67,21 @@ sbt assembly
7167
popd
7268
```
7369

74-
Get the path of the produced `eqwalizer.jar` file:
70+
Point the `ELP_EQWALIZER_PATH` environment variable to the path of the produced `eqwalizer.jar` file:
7571

7672
```
77-
find . -name eqwalizer.jar | readlink -f
73+
export ELP_EQWALIZER_PATH=$(find "$(pwd)" -name eqwalizer.jar)
7874
```
7975

80-
Point the `ELP_EQWALIZER_PATH` environment variable to the path returned above:
76+
Point the `EQWALIZER_DIR` environment variable to the path of the `eqwalizer_support` directory:
8177

8278
```
83-
export ELP_EQWALIZER_PATH=/path/to/eqwalizer.jar
79+
export EQWALIZER_DIR=$(find "$(pwd)" -name eqwalizer_support)
8480
```
8581

86-
Note: The ELP build assumes that you clone the eqwalizer and ELP
87-
repositories from the same starting directory, so they are
88-
"siblings". This is because there is a cross-reference within ELP to
89-
`../eqwalizer/eqwalizer_support`. If you are unable to do this, set
82+
Now we can compile ELP:
9083

9184
```
92-
export EQWALIZER_DIR=</path/to/eqwalizer_repo>/eqwalizer_support
93-
```
94-
95-
### Compile ELP
96-
97-
Clone the ELP repository:
98-
99-
```
100-
git clone https://github.com/WhatsApp/erlang-language-platform.git
101-
```
102-
103-
Enter the ELP repo and compile it:
104-
105-
```
106-
cd erlang-language-platform
10785
cargo build --release
10886
```
10987

0 commit comments

Comments
 (0)