[#52] Include stack building instructions #54
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chshersh
requested changes
Jul 27, 2022
Owner
chshersh
left a comment
There was a problem hiding this comment.
Just one suggestion to improve on the structure and help other beginners even more 👍🏻
README.md
Outdated
Comment on lines
112
to
123
| To build the project and run the tests, you can use `cabal`: | ||
|
|
||
| ```shell | ||
| cabal build all | ||
| cabal test --enable-tests --test-show-details=direct | ||
| ``` | ||
| or `stack`: | ||
|
|
||
| ```shell | ||
| stack build | ||
| stack test | ||
| ``` |
Owner
There was a problem hiding this comment.
That's great! I'm thinking about making instructions more beginner-friendly so everyone without prior knowledge of Haskell tooling can have a quick start guide or at least pointers to where get the tooling. So something like this:
To build the project and run the tests locally, you can use either `cabal` or `stack`.
### Cabal
1. Install [GHCup](...). It also install GHC (a Haskell compiler) and `cabal` (a Haskell build tool).
2. Build the project
3. Run the tests
### Stack
1. Install [Stack](...)
2. Build the project
3. Run the tests
chshersh
reviewed
Jul 27, 2022
Owner
chshersh
left a comment
There was a problem hiding this comment.
One minor comment but overall looks good 🙂
Co-authored-by: Dmitrii Kovanikov <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #52