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.

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

Update install instructions on landing page #38

Merged
merged 9 commits into from
Nov 12, 2023
Merged
50 changes: 28 additions & 22 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,40 +33,46 @@ <h2>Introduction</h2>
<h2><a href="#install-upgrade">Install/Upgrade <span class="inline-code">cabal</span></a></h2>

<p>
To install the <span class="inline-code">cabal</span> executable you can
use <a href="https://gitlab.haskell.org/haskell/ghcup-hs">ghcup</a> (if you're using
Linux), the <a href="https://www.haskell.org/platform/">Haskell
Platform</a>, install the <span class="inline-code">cabal-install</span>
package from your distributions package manager (if using Linux or Mac),
or download the source or prebuilt binary from
the <a href="download.html">Download</a> page.
The recommended method to install the <span class="inline-code">cabal</span> executable
is to use <a href="https://www.haskell.org/ghcup/">ghcup</a>, which can manage multiple
versions of <span class="inline-code">cabal</span> on Linux, Mac and Windows.
Alternatively, you can install <span class="inline-code">cabal</span> using your
distribution's package manager (if you are using Linux or Mac), or download the source
or prebuilt binary from the <a href="download.html">Download</a> page.
</p>

<p>
If you already have the <span class="inline-code">cabal</span> executable you can upgrade it by running:
If you have installed <span class="inline-code">cabal</span> using <a href="https://www.haskell.org/ghcup/">ghcup</a>,
then you can also upgrade it using <span class="inline-code">ghcup</span>.
If you installed the <span class="inline-code">cabal</span> executable using a different method,
you can upgrade it by running:
<code>
<span class="code-unselectable"data-text="$ "></span>cabal install cabal-install
</code><br>
This will install the cabal executable in cabal's <span class="inline-code">installdir</span>
(usually <span class="inline-code">~/.local/bin</span>). In order to use this executable,
you have to make sure that this directory appears in the <span class="inline-code">$PATH</span>
variable before the location where your current <span class="inline-code">cabal</span> executable is located.
You can check which version of the <span class="inline-code">cabal</span> executable
you are running by executing the command below.
<code>
<span class="code-unselectable" data-text="$ ">cabal --version</span>
</code>
</p>

<p>
If the above command failed for any reason see the <a href="#troubleshooting">Update Troubleshooting</a> section below.
</p>

<p>
Sometimes the older installed version is still on the program search
<span class="inline-code">$PATH</span>, you can check you're running the
latest version with the command below. If it doesn't match the output of
the <span class="inline-code">cabal-install</span> command above you'll
need to replace the old executable with the new one.<br>

<code>
<span class="code-unselectable" data-text="$ ">cabal --version</span>
</code>
If the update failed for any reason, see the <a href="#troubleshooting">Update Troubleshooting</a>
section below.
</p>

<h2>Quick Start Guide</h2>

<p>Start by installing the <span class="inline-code">cabal</span> executable (see <a href="#install-upgrade">the previous section</a>) and the Haskell compiler <span class="inline-code">ghc</span> (see <a href="https://www.haskell.org/ghc/download.html">the GHC download docs</a>).</p>
<p>Start by installing the <span class="inline-code">cabal</span> executable
(see <a href="#install-upgrade">the previous section</a>) and the Haskell compiler
<span class="inline-code">ghc</span>.
It is also recommended to use <a href="https://www.haskell.org/ghcup/">ghcup</a> to install
<span class="inline-code">ghc</span>.
</p>

<h3>Starting a new project</h3>
<p>
Expand Down