-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the README #225
Improve the README #225
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really a great work, congrats @fendor. Writing documentation is sometimes harder that writing the code.
Looks nice to me, only one minor comment.
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. |
Aims to make it easier to understand for newcomers.
It should be a nice introduction on how to write a
hie.yaml
file.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