Skip to content

Commit 1f77597

Browse files
committed
Reformat the setting up page
1 parent 1244c00 commit 1f77597

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

doc/install_and_upgrade.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ used, it sets other things up as needed.
2626

2727
Command `stack --version` or `stack --numeric-version`.
2828

29-
???+ question "If I don't use GHCup, is there a preferred location for Stack?"
29+
??? question "If I don't use GHCup, is there a preferred location for Stack?"
3030

3131
You can put the `stack` executable file anywhere on your PATH. However, a
3232
good location is the directory where Stack itself will install executables.
@@ -70,13 +70,14 @@ To get and use Stack, some other things need to be in place first:
7070

7171
---
7272

73-
Stack will need at least about 5 GB of disk space (about 3 GB for a single
74-
version of GHC and about 2 GB for a local copy of the Hackage package
75-
index).
73+
Stack will need at least about 5 GB of disk space[^1]. It will help to know
74+
what platform your computer provides.
7675

77-
It will help to know what platform your computer provides - that is, its
78-
machine architecture (eg x86_64, AArch64) and its operating system (eg a
79-
Linux distribution, macOS, Windows).
76+
[^1]:
77+
About 3 GB for a single version of GHC and about 2 GB for a local copy
78+
of the Hackage package index.
79+
80+
[platform]: machine architecture (eg x86_64, AArch64) and operating system (eg Linux distribution, macOS, Windows).
8081

8182
- :material-wifi:{ .lg .middle } __Access to the Internet__
8283

@@ -605,9 +606,9 @@ Stack can be installed directly or by using the GHCup tool.
605606

606607
=== "Windows"
607608

608-
Most machines using the Windows operating system have a x86_64
609-
architecture. More recently, Microsoft has provided Windows on Arm that
610-
runs on other processors.
609+
Most computers using Windows have a x86_64 machine architecture. More
610+
recently, Microsoft has provided Windows on Arm that runs on other
611+
processors.
611612

612613
=== "x86_64"
613614

@@ -745,7 +746,7 @@ Stack or GHCup to manage versions of Stack.
745746

746747
=== "Stack"
747748

748-
??? warning "If you use GHCup to manage Stack, use it consistently"
749+
??? warning "If you use GHCup to manage versions of Stack, use it consistently"
749750

750751
If you used GHCup to install Stack, you should also use GHCup to upgrade
751752
Stack.
@@ -770,26 +771,34 @@ Stack or GHCup to manage versions of Stack.
770771
For further information, see the
771772
[`stack upgrade`](commands/upgrade_command.md) documentation.
772773

774+
- __Manual download__
775+
776+
---
777+
778+
Follow the steps above to download manually the newest executable
779+
and replace the old executable.
780+
773781
- __Use a package manager__
774782

775783
---
776784

777-
If you're using a package manager and want to stick with
778-
the officially released binaries from the distribution (which may
779-
lag behind the latest version of Stack significantly), follow your
780-
normal package manager strategies for upgrading. For example:
785+
Follow your normal package manager approach to upgrading. For
786+
example:
781787

782788
~~~text
783789
apt-get update
784790
apt-get upgrade
785791
~~~
786792

793+
Be aware that officially released binaries from the distribution may
794+
lag behind the latest version of Stack significantly.
795+
787796
- __Use the `sh` installation script__
788797

789798
---
790799

791-
The `get.haskellstack.org` script supports the `-f` argument to
792-
over-write the current Stack executable. For example, command
800+
Use the `get.haskellstack.org` script with the `-f` flag to
801+
overwrite the current Stack executable. For example, command
793802
either:
794803

795804
~~~text
@@ -802,13 +811,6 @@ Stack or GHCup to manage versions of Stack.
802811
wget -qO- https://get.haskellstack.org/ | sh -s - -f
803812
~~~
804813

805-
- __Manual download__
806-
807-
---
808-
809-
Manually follow the steps above to download the newest executable
810-
from the GitHub releases page and replace the old executable.
811-
812814
</div>
813815

814816
=== "Windows"
@@ -828,8 +830,8 @@ Stack or GHCup to manage versions of Stack.
828830

829831
---
830832

831-
Manually follow the steps above to download the newest executable
832-
from the GitHub releases page and replace the old executable.
833+
Follow the steps above to download manually the newest executable
834+
and replace the old executable.
833835

834836
</div>
835837

0 commit comments

Comments
 (0)