Improve the README #225
Merged
Improve the README #225
Conversation
This file contains 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
jneira
reviewed
Jul 9, 2020
fendor
commented
Jul 9, 2020
lukel97
reviewed
Jul 9, 2020
fendor
force-pushed
the
readme-reborn
branch
3 times, most recently
from
c0b247c
to
ac7d7af
Compare
Aims to make it easier to understand for newcomers.
Includes:
* Easier examples
* References to stack and cabal component syntax
* Update out-of-date information
* Add table of contents to improve discoverabilty
* Dont change existing headlines to be "backwards" compatible
(e.g. dont make old links invalid)
* Add references in the readme for better navigation
Does not include:
* A nice glossary or a more convenient overview of common
names.
|
Maybe a little bit too late but, what do you think about mentioning |
|
Oh yeah, shoot, completely forgot about that (I actually was planning that). However, I think it is fine here, we should mention it more prominently on HLS/ghcide. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Aims to make it easier to understand for newcomers.
It should be a nice introduction on how to write a
hie.yamlfile.Also, it should cover most questions that arose during some hours
of helping developers setting up their session.
If there are questions, this README should be the first reference to look for solutions.
Includes:
(e.g. dont make old links invalid)
Does not include:
vocabulary.
Closes #198