Skip to content

Commit 62175d6

Browse files
komygMartinsos
andauthored
Update README docs (#2417)
* Update README docs * Fix typo * Fix typo * Update waspc/README.md Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com> --------- Co-authored-by: Martin Šošić <Martinsos@users.noreply.github.com>
1 parent aa22f6e commit 62175d6

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

waspc/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ the project. The best way to install it is via
3939
is a convenient way of installing and selecting versions of `cabal`, `hls` and
4040
`ghc`.
4141

42+
:warning: On Mac, we recommend using the official [ghcup](https://www.haskell.org/ghcup/) installer over Homebrew, as it works out of the box.
43+
4244
In [cabal.project](cabal.project) we're explicitly saying what compiler version
4345
to build Wasp with.
4446

4547
```cabal
4648
with-compiler: ghc-x.y.z
4749
```
4850

49-
Ensure that you have this [ghc
50-
version](https://downloads.haskell.org/ghc/latest/docs/html/users_guide/intro.html#ghc-version-numbering-policy)
51-
installed.
51+
Please ensure that you have this ghc version installed.
5252

5353
### Repo
5454

@@ -69,7 +69,9 @@ If that is the case, relax and feel free to get yourself a cup of coffee! When s
6969

7070
:warning: You may need to run `cabal update` before attempting to build if it has been some time since your last update.
7171

72-
:warning: If you are on Mac and get "Couldn't figure out LLVM version!" error message while building, make sure you have LLVM installed and that it is correctly exposed via env vars (PATH, LDFLAGS, CPPFLAGS). The easiest way to do it is by just running `brew install llvm@13`, this should install LLVM and also set up env vars in your `~/.zshrc`.
72+
:warning: If you are on Mac and get "Couldn't figure out LLVM version!" error message while building, make sure you have LLVM installed and that it is correctly exposed via env vars (PATH, LDFLAGS, CPPFLAGS). The easiest way to do it is by just running `brew install llvm@13`, this should install LLVM and also set up env vars.
73+
74+
:warning: If the LLVM error persists even after its installation, you may need to manually add it your PATH. To do this, you should add the following to end of your shell rc file (e.g. *~/.bashrc* or *~/.zshrc*): `export PATH="/opt/homebrew/Cellar/llvm@13/13.0.1_2/bin/:$PATH"`.
7375

7476
### Test
7577

0 commit comments

Comments
 (0)