This repository was archived by the owner on Oct 5, 2022. It is now read-only.
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.
The main changes I made were to:
README
to highlight that the plugin requires additional dependenciesAs somebody new to Atom this bit me because I had no idea why this plugin didn't do anything when I installed it. New users (like me) don't necessarily understand that they need to have the
language-haskell
plugin installed in order for file detection to work. The requirements section was buried pretty deep in the README so this note just points out to the user as visibly as possible that additional action is required before using the plugin2. Provide detailed instructions on how to install all executable and make sure that Atom can locate them
Many Haskell newcomers need a lot of hand-holding here since they may not be that familiar with how executable search paths or the Haskell toolchain works, especially if they are Windows where that sort of thing is a huge mess.
3. Provide
stack
-based installation instructions for executableThis improves the chance that users don't run into build failures when trying to compile executables