search

massive-oss / MassiveUnit

munit is a cross-platform unit testing framework for Haxe. Utilises metadata markup for test cases and includes tools for generating, compiling and running test cases from the command line.
Other
181 stars 56 forks source link

Better on-boarding / curbside appeal #154

Open jcward opened 6 years ago

jcward commented 6 years ago

FYI, this was my experience evaluating this library. Pardon me for the brutal feedback, but knowing users' initial experiences can be invaluable. Take it or leave it:

Ok, I'm looking to implement unit tests for my shiny new project. I've heard munit is good, let's check it out!

The README tells how to install, and mentions some features, and goes into great detail, but does not tell me how to actually use munit in my project. This snippet doesn't tell me anything:

selection_999 2430

I already knew it was a unit testing library before I got here. I need to know how to use it. Where do I put that test? How do I invoke it?

Then a list of features, blah blah... Ok, I see a wiki link, great!

... Huh... the wiki provides exactly the same information as the README. Hmm... Still no "how to use it" section. Alright, now I have to scan the table of contents:

selection_999 2431

Ah, "compiling and running tests" -- this must be it... Nope, sill no info on "project setup". Sigh. Too much to grok.

Go look at buddy. Up and running in 5 minutes.

elsassph commented 6 years ago

Agreed, the onboarding is pretty bad.