View unanswered posts | View active topics It is currently Thu Jun 20, 2013 4:19 am



Reply to topic  [ 3 posts ] 
 Misleading/incomplete installation instructions 
Author Message

Joined: Fri May 06, 2011 6:18 pm
Posts: 2
Post Misleading/incomplete installation instructions
This has been mentioned before on this forum, but I fell a victim yesterday and feel the need to bump the topic.

On the website, it says:
Quote:
It is really simple to get started with MigLayout. All you need to do is to download the correct .jar from above and add it to you classpath. That's it!

That's not enough, especially if you are working at the command line. I lost a few hours while "fixing" my classpath, reinstalling MigLayout, pulling my hair, etc. Finally, after a deep Google I found the "fix" here:

Quote:
import net.miginfo.com.swing.MigLayout
import javax.swing.*

I argue that at the very least the import for MigLayout should be part of the "really simple" getting started instructions. It's a trivial change to the website, and may save the next guy some trouble-shooting time.

I propose the following change:
Quote:
It is really simple to get started with MigLayout. All you need to do is to download the correct .jar from above and add it to you classpath. And, if you're working at the command line, or if your IDE does not automatically handle it, add the following line to your source code:
Code:
import net.miginfo.com.swing.MigLayout
That's it!


Tom.


Fri May 06, 2011 6:38 pm
Profile
Site Admin

Joined: Mon Dec 06, 2004 4:24 pm
Posts: 2485
Location: Sweden
Post Re: Misleading/incomplete installation instructions
Well, imports are needed for every single class you don't fully qualify so that's nothing particular to MiGLayout. And any decent IDE will do it automatically for you.

Cheers,
Mikael


Fri May 06, 2011 8:00 pm
Profile WWW

Joined: Fri May 06, 2011 6:18 pm
Posts: 2
Post Re: Misleading/incomplete installation instructions
Quote:
And any decent IDE will do it automatically for you.

Yes, well as I stated, I was working at the command line, and following the published instructions exactly (i.e. only adding MigLayout to my classpath).

The required import is (IMO) not obvious from any of the readily available documentation. I certainly would never have guessed it.

For a quick evaluation of MigLayout I don't bother with the bloat and overhead of an IDE, and I got stuck instantly.

I'll repeat my suggested change (emphasis added):

Quote:
It is really simple to get started with MigLayout. All you need to do is to download the correct .jar from above and add it to you classpath. And, if you're working at the command line, or if your IDE does not automatically handle it, add the following line to your source code:
Code:
import net.miginfo.com.swing.MigLayout

That's it!

Tom.


Fri May 06, 2011 8:19 pm
Profile
Display posts from previous:  Sort by  
Reply to topic   [ 3 posts ] 

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
cron
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by STSoftware for PTF.