snowkit/atom-haxe

The "Requirements" section inside readme.md should explict "Haxe" as one of the requirements

frenetic opened this issue · 5 comments

It's not clear that having Haxe is a requirement for this package to work.
Installing this package without this requirement will result on Atom displaying warnings/errors.
Even though it's acceptable to assume that Haxe developers have Haxe installed on their machines, it shouldn't be a "hidden dependence" for this package.

Also, at least for my specific case, I don't have Haxe installed. For now, since Im learning the language, Im using Vagrant/VMs with Haxe.

hmm, I'm not sure I understand - The only requirements are listed:

requires linter package
requires language-haxe package
requires autocomplete-plus package

This package is called "haxe" on atom packages, the other is called "language-haxe" and it's listed as a requirement already?

It should (if you didn't have it installed) pop up a modal message that you have to manually dismiss, and it tells you that you need it:

screenshot 2015-03-14 10 27 49

Am I misunderstanding maybe? :)

Sorry, I was not clear enough. My bad :(

The requirements section should explicit that "You need the Haxe language to be installed on your computer".
if you dont have it installed, you get this errors.

haxe_dependence

Aha, Ok I see - that makes sense, I will amend the requirements.

Thanks 🐹

You should see an update as well but the readme was updated.
Thanks!