Skip to content

Commit c2e24e8

Browse files
slelmgsloan
authored andcommitted
Update README.md: fix typos and formatting
Fix minor typos and formatting issues.
1 parent 59890ca commit c2e24e8

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

doc/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,22 @@ stack exec my-project-exe
4747
```
4848

4949
- The `stack new` command will create a new directory containing all
50-
the needed files to start a project correctly.
50+
the needed files to start a project correctly.
5151
- The `stack setup` will download the compiler if necessary in an isolated
5252
location (default `~/.stack`) that won't interfere with any system-level
5353
installations. (For information on installation paths, please use the
5454
`stack path` command.).
5555
- The `stack build` command will build the minimal project.
5656
- `stack exec my-project-exe` will execute the command.
5757
- If you just want to install an executable using stack, then all you have to do
58-
is `stack install <package-name>`.
58+
is `stack install <package-name>`.
5959

6060
If you want to launch a REPL:
6161

6262
```bash
6363
stack ghci
6464
```
6565

66-
6766
Run `stack` for a complete list of commands.
6867

6968
##### Workflow
@@ -90,19 +89,20 @@ So to manage your library:
9089

9190
1. Edit files in the `src/` directory.
9291

93-
The `app` directory should preferably contain only files related to
94-
executables.
92+
The `app` directory should preferably contain only files related to
93+
executables.
9594

96-
2. If you need to include another library (for example the package [`text`](https://hackage.haskell.org/package/text):
95+
2. If you need to include another library (for example the package
96+
[`text`](https://hackage.haskell.org/package/text)):
9797

9898
- Add the package `text` to the file `my-project.cabal`
9999
in the section `build-depends: ...`.
100-
- run `stack build` another time
100+
- Run `stack build` another time.
101101

102102
3. If you get an error that tells you your package isn't in the LTS.
103103
Just try to add a new version in the `stack.yaml` file in the `extra-deps` section.
104104

105-
It was a really fast introduction on how to start to code in Haskell using `stack`.
105+
That was a really fast introduction on how to start to code in Haskell using `stack`.
106106
If you want to go further, we highly recommend you to read the [`stack` guide](GUIDE.md).
107107

108108
#### How to contribute
@@ -132,7 +132,7 @@ stack setup && \
132132
stack build
133133
```
134134

135-
If you need to check you changes quickly run:
135+
If you need to check your changes quickly run:
136136

137137
```bash
138138
stack ghci
@@ -145,17 +145,17 @@ the current directory.
145145

146146
#### Complete guide to stack
147147

148-
This repository also contains a complete [user guide to using stack
149-
](GUIDE.md), covering all of the most common use cases.
148+
This repository also contains a complete [user guide to using
149+
stack](GUIDE.md), covering all of the most common use cases.
150150

151151

152152
#### Questions, Feedback, Discussion
153153

154154
* For frequently asked questions about detailed or specific use-cases, please
155155
see [the FAQ](faq.md).
156-
* For general questions, comments, feedback and support please write
156+
* For general questions, comments, feedback and support, please write
157157
to [the stack mailing list](https://groups.google.com/d/forum/haskell-stack).
158-
* For bugs, issues, or requests please
158+
* For bugs, issues, or requests, please
159159
[open an issue](https://github.com/commercialhaskell/stack/issues/new).
160160
* When using Stack Overflow, please use [the haskell-stack
161161
tag](http://stackoverflow.com/questions/tagged/haskell-stack).
@@ -169,7 +169,7 @@ easy-to-learn interface, while providing the customizability and
169169
power experienced developers need. As a build tool, Stack does not
170170
stand alone. It is built on the great work provided by:
171171

172-
* The __Glasgow Haskell Compiler__ (GHC), the premiere Haskell
172+
* The __Glasgow Haskell Compiler__ (GHC), the premier Haskell
173173
compiler. Stack will manage your GHC installations and automatically
174174
select the appropriate compiler version for your project.
175175
* The __Cabal build system__, a specification for defining Haskell
@@ -189,4 +189,5 @@ commercial Haskell users, and has since become a thriving open source
189189
project meeting the needs of Haskell users of all stripes.
190190

191191
If you'd like to get involved with Stack, check out the
192-
[newcomer friendly](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3a%22newcomer+friendly%22) label on the Github issue tracker.
192+
[newcomer friendly](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3a%22newcomer+friendly%22)
193+
label on the Github issue tracker.

0 commit comments

Comments
 (0)