Documentation lacks sufficient setup information to prevent missing class error.

[pante]

Documentation lacks sufficient setup information to prevent missing class error.

[Pante]

Thanks for the detailed issue, I've updated the documentation & will release 2.0.1 to address the missing dependency issue.

EDIT:
2.0.1 has been published and should be available shortly, do let me know if the issue persists.

[garretwilson]

OK, good news; I'm making progress. It turns out there is a separate documentation page indicating that I must configure my project to copy all the unit test source files to the test-classes target (output) directory so that Elementary can find them.

I understand why Elementary requires this, but it wasn't clear from the documentation that this step was required. (A new user doesn't automatically know the mechanism Elementary uses to find and compile the source code.)

As noted in #295, it will break unless Utilitary is added as a dependency. (As I mentioned elsewhere it's unclear to me why Elementary doesn't include this dependency transitively already.)

I would recommend that as part of the documentation you have a "getting started" section that provides a list of everything needed to use Elementary, including:

• adding the additional JUnit dependency (#293)
• including Utilitary (#295), and
• updating the project to copy source files.

The current home page and the tour make it seem like I can just add a dependency to JUnit and to Utilitary and I'm good to go, but as this ticket shows, further steps need to be performed.

[garretwilson]

I have this working for my initial use case, and so far it is very nice and does just what I needed! Thus I think the issue here is simply insufficient and misleading documentation.

[garretwilson]

Thanks for being attentive to my feedback and for quickly making changes. I've tried out the new v2.0.1 and it seems to be working well. I've just started using the library, but so far it seems to bring exactly what I needed to my unit tests. This will be really helpful.

[Pante]

Forgot to close this issue, whoops.