From 62175d699c1a10de5cf131a40e0325435a642d11 Mon Sep 17 00:00:00 2001 From: Felipe Armoni Date: Thu, 19 Dec 2024 15:16:56 -0300 Subject: [PATCH] Update README docs (#2417) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README docs * Fix typo * Fix typo * Update waspc/README.md Co-authored-by: Martin Šošić --------- Co-authored-by: Martin Šošić --- waspc/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/waspc/README.md b/waspc/README.md index 20540386d8..eb9b4b412d 100644 --- a/waspc/README.md +++ b/waspc/README.md @@ -39,6 +39,8 @@ the project. The best way to install it is via is a convenient way of installing and selecting versions of `cabal`, `hls` and `ghc`. +:warning: On Mac, we recommend using the official [ghcup](https://www.haskell.org/ghcup/) installer over Homebrew, as it works out of the box. + In [cabal.project](cabal.project) we're explicitly saying what compiler version to build Wasp with. @@ -46,9 +48,7 @@ to build Wasp with. with-compiler: ghc-x.y.z ``` -Ensure that you have this [ghc -version](https://downloads.haskell.org/ghc/latest/docs/html/users_guide/intro.html#ghc-version-numbering-policy) -installed. +Please ensure that you have this ghc version installed. ### Repo @@ -69,7 +69,9 @@ If that is the case, relax and feel free to get yourself a cup of coffee! When s :warning: You may need to run `cabal update` before attempting to build if it has been some time since your last update. -: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`. +: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. + +: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"`. ### Test