Skip to content

Commit dd8a0ed

Browse files
committed
Further related to commands in Markdown
1 parent 4dc5ca8 commit dd8a0ed

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

doc/README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,17 @@ Stack can be installed on most Unix-like operating systems, including macOS, and
2323
on Windows.
2424

2525
For most Unix-like operating systems, the easiest way to install Stack is to
26-
run:
26+
command:
2727

28-
curl -sSL https://get.haskellstack.org/ | sh
28+
~~~text
29+
curl -sSL https://get.haskellstack.org/ | sh
30+
~~~
2931

3032
or:
3133

32-
wget -qO- https://get.haskellstack.org/ | sh
34+
~~~text
35+
wget -qO- https://get.haskellstack.org/ | sh
36+
~~~
3337

3438
On 64-bit Windows, you can download and install the
3539
[Windows installer](https://get.haskellstack.org/stable/windows-x86_64-installer.exe).
@@ -50,7 +54,9 @@ instructions in the [install and upgrade guide](install_and_upgrade.md).
5054
If you already have Stack installed, you can upgrade it to the latest version
5155
by the command:
5256

53-
stack upgrade
57+
~~~text
58+
stack upgrade
59+
~~~
5460

5561
## Quick Start guide
5662

@@ -62,11 +68,12 @@ first you need to follow the [guide to install Stack](#how-to-install-Stack).
6268
To start a new project named `my-project`, issue these four commands in a
6369
terminal:
6470

65-
stack new my-project
66-
cd my-project
67-
stack build
68-
stack exec my-project-exe
69-
71+
~~~text
72+
stack new my-project
73+
cd my-project
74+
stack build
75+
stack exec my-project-exe
76+
~~~
7077

7178
- The `stack new my-project` command will create a new directory, named
7279
`my-project`, that contains all the files needed to start a project correctly,
@@ -81,20 +88,28 @@ terminal:
8188

8289
For a complete list of Stack's commands and options, simply command:
8390

84-
stack
91+
~~~text
92+
stack
93+
~~~
8594

8695
For help on a particular Stack command, for example `stack build`, command:
8796

88-
stack build --help
97+
~~~text
98+
stack build --help
99+
~~~
89100

90101
If you want to launch a run-eval-print loop (REPL), then command:
91102

92-
stack ghci
103+
~~~text
104+
stack ghci
105+
~~~
93106

94107
If you want to use Stack to install an executable provided by a Haskell package,
95108
then all you have to do is command:
96109

97-
stack install <package-name>
110+
~~~text
111+
stack install <package-name>
112+
~~~
98113

99114
### Workflow
100115

@@ -223,7 +238,9 @@ The following assumes that you already have installed a version of Stack and the
223238
If you need to check your changes quickly run `stack ghci` and then this command
224239
at the REPL's prompt:
225240

226-
:main --stack-root=<path_to_root> --stack-yaml=<path_to_stack.yaml> <COMMAND>
241+
~~~text
242+
:main --stack-root=<path_to_root> --stack-yaml=<path_to_stack.yaml> <COMMAND>
243+
~~~
227244

228245
This allows you to set a special Stack root (instead of the default Stack root)
229246
and to target your commands at a particular `stack.yaml` file instead of the one

0 commit comments

Comments
 (0)